This repository serves as a template repository for any python package development destined for PyPi. As a GitHub Template Repository, it can easily be cloned into a new repository for your own use. The repository contains:
- A skeleton for the README.md (which you're reading right now!)
- A simple
setup.pyfile - Testing with
pytestready to go - Automated testing and deployment through CircleCI
- Code coverage through Codecov
- Code maintainability and test coverage through CodeClimate
- GitHub Issues/PR templates
Do remember to change all references to pypkg to the name of your python package! These references are located in the following locations:
- Here...
- docs/README.md
- setup.py
- pytest.ini
- pypkg/ (rename to the name of your package)
Note: pypkg is not actually available on PyPi.org or installable via pip. Use the following section for your own purposes!
Once you have a suitable python environment setup, pypkg can be easily installed using pip:
pip install pypkg
pypkgis tested and supported on Python 3.5 up to Python 3.8. Usage on other versions of Python is not guaranteed to work as intended.
For full details on usage, see the documentation.
See the changelog for a history of notable changes to pypkg.
pypkg is in heavy development. Don't look, it's embarrassing!
Documentation for pypkg can be found here.
Issues and Questions should be posed to the issue tracker here.