Skip to content

TSNobleSoftware/python-package-template

PACKAGE_NAME

Short package description

Template steps

  1. Replace PACKAGE_NAME with the name of the package
  2. Replace PACKAGE_URL with the Github url of the package i.e. USER/PACKAGE_NAME
  3. Replace PACKAGE_SUPPORTED_VERSIONS with a list of supported Python versions
  4. Replace NAME and CONTACT with personal info
  5. Fill out placeholder information in setup.py
  6. Add requirements to the requirements files
  7. Add ZEST_PAT as an environment variable containing a personal access token for the Github Zest user
  8. Add PYPI_API key as an environment variable containing a PyPI API key to release the package
  9. Fill out this README and remove this section

Installation

Use the package manager pip to install PACKAGE_NAME.

pip install PACKAGE_NAME

Usage

How to use the package, with some code examples

Contributing

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!

License

Apache Software License 2.0

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages