dogeek / cli

A modular CLI that handles all my scripting needs

cli

Interactive CLI to store scripts into

• Free software: MIT license
• Documentation: https://cli.readthedocs.io.

Installation / Setup

Install this project from PyPI => pip3 install -U dogeek-cli

Once complete, the project should be installed, and the cli command should be available. You should run cli config reset at least once to initialize the global configuration file with the defaults.

Commands :

• cli plugins install $plugin_name => install a plugin from the public registry
• cli plugins upgrade => Upgrades all plugins to the latest version
• cli config set $config_key $config_value => sets a configuration key/value pair

Plugins are installed in $XDG_CONFIG_HOME/cli/plugins. On Windows, they are installed in C:\Users\$USER\AppData\Roaming\cli\plugins.

Plugins can be as simple as plain python files, which export a typer.Typer instance. They can also be more complex and be whole python modules, in that case, the module's __init__.py file should export the typer.Typer instance.

Features

• Extensible plugins system
• Built-in configuration options
• Included templating system (Mako)
• Automatic setup for logging and state management
• Public registry and publishing using asymmetric encryption for login in.
• Easily implement plugins for the CLI, supporting features such as
  • .cliignore => .gitignore/.dockerignore like file which prevents files from being packaged when publishing
  • requirements.txt support

Planned features

• Update checking for cli app
• Handle plugins dependancy management cleanly
  • install in virtualenv ?
  • config file for plugins ? Or variable in plugins => on update read requirements
  • syntax : import mylib # v1.2.3 would be good I think
  • how to handle dir plugins ? => manifest file in directory ?

cli's Issues

[feat] Register URI scheme for the app to install plugins by clicking a link

URI scheme should be cli://

Example : https://github.com/wwaites/pyfinger/blob/master/pyfinger/fingerurl.py
Doc : https://docs.python.org/3/library/urllib.request.html#basehandler-objects
SO : https://stackoverflow.com/questions/11504088/is-it-possible-to-register-an-uri-scheme-using-python

[feat] Add cli plugins rate command to rate plugins (and maintainers)

• Simple Upvote / Downvote system
• One vote per SSH key
• Detect vote manipulation attacks in the backend (fingerprinting requests? Mac address? IP address?)