Rhythmos CLI

A lightweight CLI framework. Install once, put commands in each project's commands/ folder.

Install

pip install rhythmos-cli

Usage

In any project:

rhythmos-cli make hello -d "Say hello to someone"
# edit commands/hello.py
rhythmos-cli hello Alice

rhythmos is an optional shorthand for the same CLI.

make and list are built-in system commands. If you define a user command with the same name, yours wins and a warning is printed.

Commands are loaded from ./commands (cwd), or from RHYTHMOS_COMMANDS if set.

Write a command

from rhythmos import BaseCommand


class HelloCommand(BaseCommand):
    def get_description(self):
        return "Say hello to someone"

    def add_arguments(self):
        self.parser.add_argument("name", help="Name of the person to greet")

    def handle(self, name):
        print(f"Hello, {name}!")

File commands/foo_bar.py → rhythmos-cli foo-bar.

See examples/commands/hello.py for a ready example.

Develop this package

python -m venv .venv
source .venv/bin/activate
pip install -e .
RHYTHMOS_COMMANDS=examples/commands rhythmos-cli hello World

Release (GitLab CI)

Publishes to PyPI when you push a version tag matching the version in pyproject.toml.

git tag v0.1.1
git push origin v0.1.1