Short package description
- Replace PACKAGE_NAME with the name of the package
- Replace PACKAGE_URL with the Github url of the package i.e. USER/PACKAGE_NAME
- Replace PACKAGE_SUPPORTED_VERSIONS with a list of supported Python versions
- Replace NAME and CONTACT with personal info
- Fill out placeholder information in setup.py
- Add requirements to the requirements files
- Add ZEST_PAT as an environment variable containing a personal access token for the Github Zest user
- Add PYPI_API key as an environment variable containing a PyPI API key to release the package
- Fill out this README and remove this section
Use the package manager pip to install PACKAGE_NAME.
pip install PACKAGE_NAME
How to use the package, with some code examples
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
A full contribution guide and code of conduct are supplied with the repository. In essence, update the unit tests and changelog, and treat fellow users with respect!