Python Project Wizard with Jupyter Book
Contents
Python Project Wizard with Jupyter Book¶
A tool for creating skeleton python project, built with popular develop tools and conform to best practice including Jupyter Book and its various integrations.
Features¶
This tool will create Python project with the following features:
Poetry: Manage version, dependency, build and release
Jupyter Book: Writing your docs in markdown style and jupyter notebooks
Testing with Pytest (unittest is still supported out of the box)
Code coverage report and endorsed by Codecov
Tox: Test your code against environment matrix, lint and artifact check.
Lint code with Flake8 and Flake8-docstrings
Pre-commit hooks: Formatting/linting anytime when commit/run local tox/CI
Bandit: Checking for security vulnerabilities
Command line interface using Python Fire (optional)
Continuous Integration/Deployment by github actions, includes:
publish dev build/official release to TestPyPI/PyPI automatically when CI success
publish documents automatically when CI success
extract change log from github and integrate with release notes automatically
Host your documentation from Git Pages with zero-config
Credits¶
We based this work on zillionare/cookiecutter-pypackage and borrowed some ideas from audreyr/cookiecutter-pypackage and briggySmalls.