SETUP.md

Setting Up the Repository

1. Turn your project into a GitHub repository:
   • Make an account on github.com
   • Go to make a new repository
   • Recommendations:
     • It is strongly recommended to make the repository name the same as the Python package name
     • A lot of the following optional steps are free if the repository is Public, plus open source is cool
   • After a GitHub repo has been created, run the commands listed under: "...or push an existing repository from the command line"
2. Ensure that you have set GitHub pages to build the gh-pages branch by selecting the gh-pages branch in the dropdown in the "GitHub Pages" section of the repository settings. (Repo Settings)
3. Register your project with PyPI:
   • Make an account on pypi.org
   • Go to your GitHub repository's settings and under the Secrets tab, add a secret called PYPI_TOKEN with your password for your PyPI account. Don't worry, no one will see this password because it will be encrypted.
   • Next time you push to the branch main after using bump2version, GitHub actions will build and deploy your Python package to PyPI.

You can delete this file once complete!