clicr 0.0.2

Make effective CLI apps using Python

clicr, the CLI Creator

clicr (pronounced as clicker) is the CLI Creator that aims to be the template used to make effective CLI apps using Python.

Getting Started (Development)

Install Poetry:

curl -sSL https://install.python-poetry.org | python3 -

Create new environment, or use existing environment:

# Change your python version accordingly (>=3.8)
conda create -n clicr python
conda activate clicr

Then install the dependencies in Poetry:

poetry install

You can now use the clicr in the CLI. Check clicr --help for more information.

To run the documentation, run mkdocs server and check out the site at localhost:8000.

Template Stack

• Typer
• Poetry

Development Stack

• Scriv
• MkDocs

Managing Changelog

This repository's changelog is managed by Scriv.

License

© Copyright 2022 Syakyr Surani. This program is licensed under Apache Software License 2.0.