Welcome to Python Package Template’s documentation!¶
This is an opinionated attempt to document how I deploy a python application with documentation, testing, pypi, and continuous deployment. This project will be updated as I change my python development practices. Number one this is a learning experience.
This project is a python package itself and full documentation is available on readthedocs. Each of the steps below includes a link to the section in the documentation.
- setup a bare python package with git repo (
setup.py
,README.md
,.gitignore
,<package>
) - setup pypi deployment with git tags
vX.X.X
- setup conda deployment with git tags
vX.X.X
- setup docker deployment with git tags
vX.X.X
- setup testing on each commit with
pytest
- setup documentation with
sphinx
on readthedocs and self hosted - setup command line interface with
argparse
- setup badges for README.md