This is a great template README.
- rename the
modulenamefolder - Ctrl+Shift+F -> replace
modulenamewith the actual module name - Ctrl+Shift+F -> replace
usernamewith your user/org name - Ctrl+Shift+F -> replace
lordwith your default branch name (or not,lordis nice)
publish.ymlpublishes a new release for every version bump inpyproject.toml(check outpoetry version)- Add PYPI_TOKEN variable to repository settings to publish package on PyPI, otherwise you will get an error (or just remove the
Publish on PyPIstep) - GitHub releases are created automatically, but you need to give the workflow write permissions (Settings / Actions / General / Workflow Permissions)
- Add PYPI_TOKEN variable to repository settings to publish package on PyPI, otherwise you will get an error (or just remove the
test.ymlruns several checks on PR and on push to main branchCheck Typesjob runs mypy against the module code- You may want to remove
--disallow-any-exprif you don't want errors onAny
- You may want to remove
Run Testsruns tests fromteston several Python versions folder and pushes the coverage data to Coveralls- You may want to write the actual tests
- If you don't want Coveralls integration, just remove the
Coveralls Updatestep altogether. Otherwise, check out https://docs.coveralls.io/index to set up the integration. - Check
python-versionmatrix and edit if you want a different version list
- Includes an empty
__init__.py(wow!) - Includes an empty
py.typedfile so that typecheckers treat your package as typed (see PEP 561) - You may want to write actual code
Taken from here, with poetry.lock added (consider removing that line if your package is not a library)
Just a bunch of recommendations for people contributing to your repository (if there are any)
- Includes several dev dependencies (used in workflows)
- Be sure to edit the license, author, links and other information as needed
Be sure to replace it if needed