A template for Python Projects.
- Rename the folder
your_package
and edityour_package/__init__.py
- Update
setup.py, version.txt, requirements.txt, dev_requirements.txt, LICENSE
to allow for users to install your package usingpip install .
or uploading to PyPI. - Update
README.md
. - Add the correct Makefile or batch script etc. to docs to allow for building documentation. Most likely this will use sphinx or pdoc3.
- Add your tests to the tests folder that can be run with pytest or a similar testing framework.
Optionally, you could also setup continuous integration with CircleCI or similar, and setup git hooks.
Check my website for more information.
Give a succinct description of the project.
Describe how to install stable version and dev version.
List what installation requires.
Link to where can further documentation be found.
Show the guide for contributing.
What License the project is provided under.