Python Package Template

Usage

1. Choose repository name
2. Instantiate new repository from the template repository
3. Enable or disable PyPI publishing
   • Enable
     1. Choose public package name
     2. Configure trusted publisher on PyPI
     3. Update public package name
        • pyproject.toml: update name = ..
        • README.md:
          • update pip install ..
          • remove pip install git+https://github.com..
          • update PyPI badge url: 1st url & 2nd url
   • Disable
     1. Update README.md:
        • remove pip install <package-slug>
        • remove PyPI badge
4. Configure displayed project information
   • Enable releases
   • Disable deployments and packages
5. Configure settings
   • General >
     • Automatically delete head branches
     • Always suggest updating pull request branches
     • Disable allow merge commits
   • Actions > General > Workflow permissions
     • Allow GitHub Actions to create and approve pull requests
6. Enable pre-commit CI
   • Add project to pre-commit ci app

============================================================

Run

python_package_template

Installation

pip install python-package-qtemplate

or

pip install git+https://github.com/quintenroets/python-package-template.git