Skip to content

GitHub template repository for creating new Python Click CLI tools, using the simonw/click-app cookiecutter template

Notifications You must be signed in to change notification settings

simonw/click-app-template-repository

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 

Repository files navigation

Template repository for creating new Python Click CLI tools

This GitHub template repository can be used to create a new repository with the skeleton of a Python Click CLI tool, based on the click-app cookiecutter.

Start here: https://github.com/simonw/click-app-template-repository/generate

The name of your repository will be the name of the CLI tool, and also the name of the Python package that you publish to PyPI - so make sure that name is not taken already!

Add a one-line description of your CLI tool, then click "Create repository from template".

Screenshot of the create repository interface

Once created, your new repository will execute a GitHub Actions workflow that uses cookiecutter to rewrite the repository to the desired state. This make take 30 seconds or so.

You can see an example of a repository generated using this template here:

GitHub Actions setup by this repository

The test.yml GitHub Actions workflow will run your tests automatically any time you push a change to the repo.

The publish.yml Action runs when you create a new GitHub release. It can build and upload your package to PyPI.

For this to work, you need to create an API token for your PyPI account and add that to your repository as a secret called PYPI_TOKEN.

See Publishing your library as a package to PyPI for details.

About

GitHub template repository for creating new Python Click CLI tools, using the simonw/click-app cookiecutter template

Resources

Stars

Watchers

Forks

Sponsor this project