python-module-boilerplate

Python Module Boilerplate

Features:

✔ Pip installation
✔ Sphinx Documentation
✔ Logging Configuration
✔ Typechecked Enabled
✔ Module Configuration using JSON
✔ Module Global Store
✔ Singleton Pattern
✔ Module Metadata Configuration
✔ String Constants
✔ Sample Validation
✔ Module Manager
✔ Tox Environment Testing
✔ Nose Tests
✔ Memory Leak Test- Multiple Workflows
✔ Dev Installation - Hot Code Swapping
✔ Production Installation (Cythonized Installation) - Code Obfuscation using Cython
✔ Module Uninstallation
✔ Code Statistics using CLOC utility
✔ Build Wheel Distribution
✔ Build Cythonized Distribution
✔ Support for generating code coverage
✔ Clean module - Remove cache and temp files
✔ Dependency Checker

Todo

✗ Automate Module Creation Process
✗ Hooks Implementation
✗ Github Release
✗ Addon Memory Test

Steps (To be automated soon . . .)

1. Clone the repository

git clone https://github.com/kingspp/python-module-boilerplate

2. Load the repository in your favourite IDE
3. Refactor module name to your desired name.