Python Package Template

Latest Release
Package Status
License
Build Status
Coverage
Conda
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.

• documentation (sphinx, selfhosted + readthedocs)
• testing (pytest) and coverage (pytest-cov)
• deploy to pypi (twine)
• deploy to conda (conda)
• deploy docker container to (dockerhub and gitlab container registry)
• building a package (setup.py, README.md, CHANGELOG.md, LICENSE.md)
• command line interface with argparse
• badges for testing, packages, and documentation

Assumptions:

Gitlab will be used for the continuous deployment. It is a great project that is open source and comes with many nice features not available for Github. You should consider it! Features used:

• pages
• CI/CD

If you would like a custom domain setup with gitlab pages for the documentation you will need to use cloudflare. I have a blog written on how to do this or you can look at the gitlab cloudflare documentation.

Steps

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.

1. setup a bare python package with git repo (setup.py, README.md, .gitignore, <package>)
2. setup pypi deployment with git tags vX.X.X
3. setup testing on each commit with pytest
4. setup documentation with sphinx on readthedocs and self hosted

Requirements

None!

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

The goal of this project is to in an opinionated way guide modern python packaging development for myself.

License

MIT