CLI Demo: Simple one-file CLI package implementing git hooks for linting.
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.
Chaz Reid c585339048
update codeowners
5 months ago
docs fix extension 5 months ago
.flake8 add flake8, add pre-commit config 5 months ago
.gitignore update gitignore 5 months ago
.pre-commit-config.yaml migrate pre-commit config to new style 5 months ago
CODEOWNERS update codeowners 5 months ago
LICENSE init commit 5 months ago
Readme.md update readme 5 months ago
clive.py update clive 5 months ago
mkdocs.yml add docs 5 months ago
requirements-docs.txt update requirements 5 months ago
requirements.txt update requirements with pre-config/flake8/black 5 months ago
setup.py add actual code. 5 months ago

Readme.md

clive-owen

Clive Owen

A simple one-file CLI package. Demonstrates the following:

  • How to implement a simple command line utility with Click, in a single .py file
  • How to create a setup.py file alongside the CLI utility, for a bare-minimum installation
  • How to implement git pre-commit hooks with pre-commit

Screenshot

Screenshot of pre-commit hooks in action:

Screenshot of pre-commit hooks in action

Quick start

git clone git@github.com:charlesreid1-toy-factory/clive-owen.git
cd clive-owen

# Start a virtual environment if you wish

pip install -r requirements.txt
pip install --editable .
clive --help

And to install the pre-commit hooks:

pre-commit install