Python Framework

Cookiecutter template for Python Framework.

• Source Code: https://github.com/sp-95/python-framework
• Documentation: https://sp-95.github.io/python-framework/
• Bug Reports: https://github.com/sp-95/python-framework/issues

Features

• poetry: Dependency Management
• Editor Config: Maintains Code Consistency
• flake8: Linting
• black and isort: Code Formatting
• mypy: Type Hinting
• pre_commit_hooks: Git hooks
• fire: Command-line Interface
• loguru: Logging
• dynaconf: Configuration Management
• pytest and coverage: Python Testing and Code Coverage
• Tox: Automated and Standardized testing
• Sphinx: Generates documents automatically
• GitHub Actions: Continuous Integration
• GitHub Pages: Documentation Hosting
• PyPi: Auto-deploy when you make a release (optional)
• GitHub issue templates

Quickstart

1. Install the latest framework for Python if you haven't installed it yet

   $ pip install -U python-framework

2. Initialize your project

   $ shanx-py init

3. Create a repo and put it there.

4. Generate the docs by pushing your first commit to master.

5. Deploy your package to PyPi by pushing a tag and creating a release.

For more details, see the python-framework tutorial.

Acknowledgment

This package is a modified duplicate of the audreyr/cookiecutter-pypackage project template