isis-cli 0.1.1

General purpose CLI

icli

Development set up

Without Docker

• You need to install poetry
• Run poetry install
• Run poetry run python src/main.py
• Run poetry run python src/main.py --name=Batman --count=2
• Run poetry run python src/main.py --help

With Docker

• Prerequisite: being able to run make
• Running make will show you all the possible actions

Decisions taken and personal notes

• Origin of the name:
  • i(si) + cli
  • or the typical iAnything :-)
• Library used: Click
  • The examples of code seen look simpler
  • Good opinions in several posts with comparisons with Docopts or Argparse
  • Looks like a "modern" way of creating a CLI in 2022
  • Used by AWS
• Dependencies with poetry
  • poetry show -v
  • poetry env list
• The ENTRYPOINT is the execution of the main file.

Resources

• Video tutorial: Building Command Line Applications with Click - 18 minutes
• Click examples
• https://github.com/CodiumTeam/docker-training
• https://jackmckew.dev/packaging-python-packages-with-poetry.html
  • https://github.com/JackMcKew/wordsum

TO DO

• Rename to isis-cli
• Package it to be installed from PyPI, e.g. pip install icli
• Make possible to run it
• Integrate GitHub action for running tests
• Integrate GitHub action for PyPI publication
• Version it
• Use mypy
• Use black formatter