Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

GitHub template repository for creating new Python Click CLI tools, using the simonw/click-app cookiecutter template
https://github.com/simonw/click-app-template-repository

Last synced: 26 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/simonw/click-app-template-repository
Owner: simonw
Created: 2021-08-30T01:03:34.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-05-12T17:13:00.000Z (6 months ago)
Last Synced: 2024-10-06T20:55:52.865Z (about 1 month ago)
Homepage:
Size: 18.6 KB
Stars: 28
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Template repository for creating new Python Click CLI tools

This GitHub [template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template) can be used to create a new repository with the skeleton of a Python [Click](https://click.palletsprojects.com/) CLI tool, based on the [click-app](https://github.com/simonw/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](https://pypi.org/) - 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](https://user-images.githubusercontent.com/9599/131272183-d2f1bb50-1ca1-42f2-936d-f23a6cbdbe13.png)

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:

- https://github.com/simonw/click-app-template-repository-demo

## 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](https://pypi.org/).

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](https://github.com/simonw/click-app#publishing-your-library-as-a-package-to-pypi) for details.