A Python package cookiecutter with modern tooling
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luke Murphy d6240a06fa
Remove unused var
4 weeks ago
{{cookiecutter.package}} Migrate to pyproject config 4 weeks ago
LICENSE Use the correct license 1 year ago
README.md Migrate to pyproject config 4 weeks ago
cookiecutter.json Remove unused var 4 weeks ago

README.md

pypkgtemplate

A Python package cookiecutter with modern tooling

Why another template?

A lot of cookiecutter template designers try to include all the things from the start and then due to maintenance burdens, the package template fall behind with the moving ecosystem. For example, one of the most commonly used packages, cookiecutter-pypackage has, at present moment, not been updated for a year and has 23 open change requests.

This template is about moving with the ecosystem to provide a modern and up-to-date cookiecutter template for creating Python packages. In order to keep up to speed, I focus on tooling configuration rather than code customisation. Your Python package code can be different each time but the tools should be standardised and reliable.

Usage

$ python -m pip install --user pipx
$ pipx install cookiecutter
$ cookiecutter https://git.autonomic.zone/decentral1se/pypkgtemplate.git

Variables

{
  "package": "",
  "package_description": "",
  "author": "",
  "author_email": "",
  "git_hosting_url": ""
}
  • package: The package name.
  • package_description: The package short description.
  • author: The package creator.
  • author_email: The package creator’s email.
  • git_hosting_url: The git hosting URL of the package.