https://github.com/kj-9/click-app-copier
Copier template for creating new Click command-line tools for Python
https://github.com/kj-9/click-app-copier
copier-template
Last synced: 7 months ago
JSON representation
Copier template for creating new Click command-line tools for Python
- Host: GitHub
- URL: https://github.com/kj-9/click-app-copier
- Owner: kj-9
- License: apache-2.0
- Created: 2024-10-18T14:21:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T03:45:20.000Z (11 months ago)
- Last Synced: 2025-02-06T03:27:36.559Z (9 months ago)
- Topics: copier-template
- Language: Jinja
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/copier-org/copier)
# click-app copier template
[Copier](https://github.com/copier-org/copier) template for creating new [Click](https://click.palletsprojects.com/) command-line tools.
based on brilliant [click-app](https://github.com/simonw/click-app) cookiecutter template by [Simon Willison](https://github.com/simonw) with some additional features.
## Usage
First install copier if you haven't already.
`pipx` is recommended for installing copier:
```
pipx install copier
```
then:
```bash
copier copy gh:kj-9/click-app-copier your-new-project
```
this will generate a project dir in the `./your-new-project`.
## Demo
[Here](https://github.com/kj-9/click-app-copier-template-demo) is a demo repository of a generated project using this template.
## Publishing your tool as a package to PyPI
The template also includes a publish.yml GitHub Actions workflow for publishing packages to PyPI, using pypa/gh-action-pypi-publish.
To use this action, you need to create a PyPI account and configure a Trusted Publisher for this package.
Once you have created your account, navigate to https://pypi.org/manage/account/publishing/ and create a "pending publisher" for the package. Use the following values:
PyPI Project Name: The name of your package
Owner: Your GitHub username or organization - the "foo" in github.com/foo/bar
Repsitory name: The name of your repository - the "bar" in github.com/foo/bar
Workflow name: publish.yml
Environment name: release
Now, any time you create a new "Release" on GitHub the Action will build your package and push it to PyPI.
The tag for your release needs to match the VERSION string at the top of your pyproject.toml file. You should bump this version any time you release a new version of your package.