sample-package-chanshing 0.0.0

An example Python project

Sample PyPI package + GitHub Actions + Versioneer

How to use this template

1. Click on the Use this template button to get a copy of this repository.

2. Rename src/sample_package folder to your package name — src/ is where your package must reside.

3. Go through each of the following files and rename all instances of sample-package or sample_package to your package name. Also update the package information such as author names, URLs, etc.

   1. setup.py
   2. pyproject.toml
   3. __init__.py

4. Install versioneer and tomli, and run versioneer:

   $ pip install tomli
   $ pip install versioneer
   $ versioneer install
   

   Then commit the changes produced by versioneer. See here to learn more.

5. Setup your PyPI credentials. See the section Saving credentials on Github of this guide.