PyPI and GitHub Actions. Closes #43 #44
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
This PR includes the following:
Added GitHub actions workflow for automatic release of PyPI package. The GitHub action workflow will not run every time there is a push to
master. Instead, it will run when you add a new tag to your repo. This allows you to push new changes tomasterand once you are ready to publish a new version, all you need to do is update the version number (inpyproject.toml) and create a new tag. Here is a StackOverflow forum that explains how to create new Git tags: here.Key things to consider when publishing to PyPI:
pyproject.toml'sversionvalue to a new version (e.g.v0.0.2) when publishing new version. Don't try to publishv0.0.1whenv0.0.1is already in PyPI (this will cause the workflow to fail). For the first time, you don't need to change anything.Also, this PR includes changes to the
README.md, added doc-building dependencies topyproject.toml, and build the docs with the latestREADME.md(might want to triple-check that I didn't build bad docs).