python-template

python-template

Steps

• Review settings of the repo
• Select a License and update pyproject.toml file accordingly
• Add branch protection
• Replace python-template everywhere with the name of the new project
• Replace the folder python-template with the name of the new project
• Solve todos around the files
• Create virtualenv, install pip-tools, freeze dependencies and install dependencies
• Create token in PyPi and add to GitHub secrets
• Add badges that apply in the readme (version, release, downloads, python supported, ci, tools, etc.)
• Add some classifiers and keywords
• Review security setup (security tab). All checks should be in green.
• Check the repo has sponsors enabled.
• Create the major, minor and patch labels in de repository.
• Remove this steps and do the first release (0.0.1) and update the website of the project!

Installation

Use the package manager pip to install python-template.

pip install python-template

Usage

# todo

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Sponsors

Become a sponsor here

License

#todo