https://github.com/copperlight/pycli-example
https://github.com/copperlight/pycli-example
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/copperlight/pycli-example
- Owner: copperlight
- License: apache-2.0
- Created: 2021-10-01T17:57:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-04T03:24:25.000Z (about 4 years ago)
- Last Synced: 2025-12-26T16:44:30.572Z (6 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/copperlight/pycli-example/actions/workflows/snapshot.yml) [](https://github.com/copperlight/pycli-example/actions/workflows/release.yml)
## Introduction
This project provides a minimal example of CLI application packaging for Python.
## Installation
This package supports Python >= 3.6.
Install:
```
pip3 install git+https://github.com/copperlight/pycli-example.git
```
Upgrade:
```
pip3 install --upgrade git+https://github.com/copperlight/pycli-example.git
```
## Local Development
Setup and activate a virtualenv, for local development:
```shell
./setup-venv.sh
source venv/bin/activate
```
Run tests locally:
```
pytest
```
Run the latest version locally, so you can skip installing the package and cycle faster:
```
python3 ./pycli_example/cmd.py -h
```
Install the CLI app in the virtualenv, so you can run it as a user would:
```shell
python3 setup.py install
pycli-example -h
pycli-example -n Frasier
```
## Release Process
* Make some changes.
* Bump the version in [setup.py](./setup.py), maybe following [Semantic Versioning](https://semver.org/).
* Update the [CHANGELOG.md](./CHANGELOG.md).
* Push the changes.
* Upgrade the package on user systems.