rhythmos-cli 26.8.2__tar.gz → 26.10.5__tar.gz

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/.gitignore

@@ -1,8 +1,10 @@
 /.venv
 /.ipynb_checkpoints
 
-/.pytest_cache
-/.ruff_cache
+# Generated by hatch-vcs on build / editable install
+/src/rhythmos/_version.py
+
+/.pytest_cache/.ruff_cache
 /.mypy_cache
 /.tox
 /.direnv
@@ -27,4 +29,6 @@
 data/**/*.yml
 
 .DS_Store
-environment/*.env
+environment/*.env
+
+.cursor/

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: rhythmos-cli
-Version: 26.8.2
+Version: 26.10.5
 Summary: A lightweight CLI framework with project-local auto-discovered commands
 Project-URL: Homepage, https://gitlab.com/JoanMbela/rhythmos-cli
 Project-URL: Repository, https://gitlab.com/JoanMbela/rhythmos-cli
@@ -20,6 +20,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Rhythmos CLI
@@ -74,15 +76,20 @@ See `examples/commands/hello.py` for a ready example.
 ```bash
 python -m venv .venv
 source .venv/bin/activate
-pip install -e .
+pip install -e ".[dev]"
 RHYTHMOS_COMMANDS=examples/commands rhythmos-cli hello World
+pytest
 ```
 
 ## Release (GitLab CI)
 
-Publishes to PyPI when you push a version tag matching the version in `pyproject.toml`.
+Version comes from **git tags** (no manual edits in `pyproject.toml`). Pushing a tag builds and publishes that version:
 
 ```bash
-git tag v0.1.1
-git push origin v0.1.1
+git add -A && git commit -m "..." 
+git tag v26.10.2
+git push origin v26.10.2
 ```
+
+Requires CI variable `PYPI_TOKEN` (masked + protected) and protected tags `v*`.
+If a tag pipeline fails, push a **new** tag — protected tags usually cannot be deleted via `git`.

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/README.md

@@ -50,15 +50,20 @@ See `examples/commands/hello.py` for a ready example.
 ```bash
 python -m venv .venv
 source .venv/bin/activate
-pip install -e .
+pip install -e ".[dev]"
 RHYTHMOS_COMMANDS=examples/commands rhythmos-cli hello World
+pytest
 ```
 
 ## Release (GitLab CI)
 
-Publishes to PyPI when you push a version tag matching the version in `pyproject.toml`.
+Version comes from **git tags** (no manual edits in `pyproject.toml`). Pushing a tag builds and publishes that version:
 
 ```bash
-git tag v0.1.1
-git push origin v0.1.1
+git add -A && git commit -m "..." 
+git tag v26.10.2
+git push origin v26.10.2
 ```
+
+Requires CI variable `PYPI_TOKEN` (masked + protected) and protected tags `v*`.
+If a tag pipeline fails, push a **new** tag — protected tags usually cannot be deleted via `git`.

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [project]
 name = "rhythmos-cli"
-version = "26.8.2"
+dynamic = ["version"]
 description = "A lightweight CLI framework with project-local auto-discovered commands"
 readme = "README.md"
 license = "MIT"
@@ -31,10 +31,22 @@ classifiers = [
 Homepage = "https://gitlab.com/JoanMbela/rhythmos-cli"
 Repository = "https://gitlab.com/JoanMbela/rhythmos-cli"
 
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+
 [project.scripts]
 rhythmos-cli = "rhythmos.cli:main"
 rhythmos = "rhythmos.cli:main"
 
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+local_scheme = "no-local-version"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/rhythmos/_version.py"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/rhythmos"]
 
@@ -42,6 +54,11 @@ packages = ["src/rhythmos"]
 include = [
     "/src",
     "/examples",
+    "/tests",
     "/README.md",
     "/LICENCE",
 ]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

rhythmos_cli-26.10.5/src/rhythmos/__init__.py

@@ -0,0 +1,16 @@
+"""Rhythmos — a lightweight project CLI framework."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from rhythmos.argument import Argument
+from rhythmos.base_command import BaseCommand
+
+try:
+    __version__ = version("rhythmos-cli")
+except PackageNotFoundError:  # pragma: no cover - editable / source tree
+    try:
+        from rhythmos._version import __version__
+    except ImportError:
+        __version__ = "0.0.0"
+
+__all__ = ["Argument", "BaseCommand", "__version__"]

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/src/rhythmos/__main__.py

@@ -1,4 +1,4 @@
 from rhythmos.cli import main
 
 if __name__ == "__main__":
-    main()
+    main(include_system_commands=True)

rhythmos_cli-26.10.5/src/rhythmos/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '26.10.5'
+__version_tuple__ = version_tuple = (26, 10, 5)
+
+__commit_id__ = commit_id = None

rhythmos_cli-26.10.5/src/rhythmos/argument.py

@@ -0,0 +1,36 @@
+def _action_name(parser, action):
+    registry = parser._registries["action"]
+    for name, registered in registry.items():
+        if name is not None and type(action) is registered:
+            return name
+    return type(action)
+
+
+class Argument:
+    """Declaration of one command argument.
+
+    Names and keywords match argparse's ``add_argument``.
+    """
+
+    def __init__(self, *names, **options):
+        self.names = tuple(names)
+        self._options = options
+
+    def apply(self, parser):
+        parser.add_argument(*self.names, **self._options)
+
+    @classmethod
+    def from_action(cls, action, parser):
+        argument = cls.__new__(cls)
+        argument.names = tuple(action.option_strings) or (action.dest,)
+        argument.dest = action.dest
+        argument.help = action.help
+        argument.type = action.type
+        argument.default = action.default
+        argument.action = _action_name(parser, action)
+        argument.nargs = action.nargs
+        argument.const = action.const
+        argument.choices = action.choices
+        argument.required = action.required
+        argument.metavar = action.metavar
+        return argument

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/src/rhythmos/base_command.py

@@ -1,5 +1,7 @@
 import argparse
 
+from rhythmos.argument import Argument
+
 
 class BaseCommand:
     def __init__(self):
@@ -12,6 +14,17 @@ class BaseCommand:
     def add_arguments(self):
         pass
 
+    def add_args(self, *arguments: Argument) -> None:
+        for argument in arguments:
+            argument.apply(self.parser)
+
+    def get_arguments(self) -> list[Argument]:
+        return [
+            Argument.from_action(action, self.parser)
+            for action in self.parser._actions
+            if not isinstance(action, argparse._HelpAction)
+        ]
+
     def handle(self, *args, **options):
         raise NotImplementedError("You must implement the handle method.")
 

{rhythmos_cli-26.8.2 → rhythmos_cli-26.10.5}/src/rhythmos/cli.py

@@ -5,10 +5,18 @@ from rhythmos.base_command import BaseCommand
 from rhythmos.discovery import commands_dir, discover_commands, invoked_as
 from rhythmos.system_commands import SYSTEM_COMMANDS
 
+OFFICIAL_CLIS = frozenset({"rhythmos", "rhythmos-cli"})
 
-def resolve_commands() -> dict[str, type[BaseCommand]]:
+
+def resolve_commands(
+    include_system_commands: bool = True,
+) -> dict[str, type[BaseCommand]]:
     """Merge system + user commands. User commands win on name clashes."""
     user = discover_commands()
+
+    if not include_system_commands:
+        return {**user}
+
     for name in user:
         if name in SYSTEM_COMMANDS:
             print(
@@ -18,16 +26,23 @@ def resolve_commands() -> dict[str, type[BaseCommand]]:
     return {**SYSTEM_COMMANDS, **user}
 
 
-def main(argv: list[str] | None = None) -> None:
+def main(
+    argv: list[str] | None = None,
+    *,
+    include_system_commands: bool | None = None,
+) -> None:
     argv = list(sys.argv[1:] if argv is None else argv)
     cli = invoked_as()
+    if include_system_commands is None:
+        # Official entry points expose make/list; project wrappers do not by default.
+        include_system_commands = cli in OFFICIAL_CLIS
 
     parser = argparse.ArgumentParser(prog=cli, description="Rhythmos CLI")
     subparsers = parser.add_subparsers(
         dest="command", help="Command to execute", required=True
     )
 
-    commands = resolve_commands()
+    commands = resolve_commands(include_system_commands)
     command_instances = {}
 
     for command_name, command_class in commands.items():

rhythmos_cli-26.10.5/tests/test_arguments.py

@@ -0,0 +1,131 @@
+import argparse
+
+from rhythmos import Argument, BaseCommand
+
+
+class CountCommand(BaseCommand):
+    def add_arguments(self):
+        self.add_args(
+            Argument("count", type=int),
+            Argument("--label", default="hi", help="label"),
+        )
+
+
+def test_add_args_parses_positional_and_optional():
+    command = CountCommand()
+
+    parsed = command.parser.parse_args(["3"])
+    assert parsed.count == 3
+    assert parsed.label == "hi"
+
+    parsed = command.parser.parse_args(["3", "--label", "yo"])
+    assert parsed.count == 3
+    assert parsed.label == "yo"
+
+
+def test_get_arguments_projects_the_batch():
+    arguments = CountCommand().get_arguments()
+
+    assert len(arguments) == 2
+    count, label = arguments
+
+    assert count.names == ("count",)
+    assert count.dest == "count"
+    assert count.help is None
+    assert count.type is int
+    assert count.default is None
+    assert count.action == "store"
+
+    assert label.names == ("--label",)
+    assert label.dest == "label"
+    assert label.help == "label"
+    assert label.type is None
+    assert label.default == "hi"
+    assert label.action == "store"
+
+    assert BaseCommand().get_arguments() == []
+
+
+class CustomAction(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        setattr(namespace, self.dest, values)
+
+
+class MixedCommand(BaseCommand):
+    def add_arguments(self):
+        self.add_args(Argument("name", help="who"))
+        self.parser.add_argument("--flag", action="store_true")
+        self.add_args(Argument("--label", default="x", help="label"))
+        self.parser.add_argument("--custom", action=CustomAction)
+
+
+def test_get_arguments_includes_both_registration_paths():
+    arguments = MixedCommand().get_arguments()
+    name, flag, label, custom = arguments
+
+    assert [argument.names for argument in arguments] == [
+        ("name",),
+        ("--flag",),
+        ("--label",),
+        ("--custom",),
+    ]
+    assert name.dest == "name"
+    assert name.help == "who"
+    assert name.action == "store"
+    assert name.default is None
+
+    assert flag.dest == "flag"
+    assert flag.help is None
+    assert flag.action == "store_true"
+    assert flag.default is False
+
+    assert label.dest == "label"
+    assert label.help == "label"
+    assert label.default == "x"
+    assert label.action == "store"
+
+    assert custom.dest == "custom"
+    assert custom.action is CustomAction
+    assert all(
+        name not in {"-h", "--help"}
+        for argument in arguments
+        for name in argument.names
+    )
+
+
+class KeywordCommand(BaseCommand):
+    def add_arguments(self):
+        self.add_args(
+            Argument("name"),
+            Argument("--flag", action="store_true"),
+        )
+        self.parser.add_argument(
+            "--choice",
+            choices=("a", "b"),
+            metavar="X",
+            nargs="?",
+            const="a",
+            required=True,
+        )
+
+
+def test_get_arguments_projects_resolved_keywords():
+    name, flag, choice = KeywordCommand().get_arguments()
+
+    assert name.nargs is None
+    assert name.const is None
+    assert name.choices is None
+    assert name.required is True
+    assert name.metavar is None
+
+    assert flag.nargs == 0
+    assert flag.const is True
+    assert flag.choices is None
+    assert flag.required is False
+    assert flag.metavar is None
+
+    assert choice.nargs == "?"
+    assert choice.const == "a"
+    assert choice.choices == ("a", "b")
+    assert choice.required is True
+    assert choice.metavar == "X"

rhythmos_cli-26.10.5/tests/test_cli.py

@@ -0,0 +1,118 @@
+import pytest
+
+from rhythmos.base_command import BaseCommand
+from rhythmos.cli import main, resolve_commands
+from rhythmos.discovery import (
+    COMMANDS_DIR_ENV,
+    discover_commands,
+    scaffold_command,
+    to_class_name,
+    to_snake,
+)
+from rhythmos.system_commands import SYSTEM_COMMANDS
+from rhythmos.system_commands.list import ListCommand
+from rhythmos.system_commands.make import MakeCommand
+
+
+HELLO_CMD = """\
+from rhythmos import BaseCommand
+
+
+class HelloCommand(BaseCommand):
+    def get_description(self):
+        return "Say hello"
+
+    def add_arguments(self):
+        self.parser.add_argument("name")
+
+    def handle(self, name):
+        print(f"Hello, {name}!")
+"""
+
+
+@pytest.fixture
+def commands_home(tmp_path, monkeypatch):
+    directory = tmp_path / "commands"
+    directory.mkdir()
+    monkeypatch.setenv(COMMANDS_DIR_ENV, str(directory))
+    return directory
+
+
+def test_to_snake_and_class_name():
+    assert to_snake("HelloWorld") == "hello_world"
+    assert to_snake("foo-bar") == "foo_bar"
+    assert to_class_name("foo_bar") == "FooBar"
+
+
+def test_discover_commands_loads_user_modules(commands_home):
+    (commands_home / "hello.py").write_text(HELLO_CMD, encoding="utf-8")
+    found = discover_commands()
+    assert set(found) == {"hello"}
+    assert issubclass(found["hello"], BaseCommand)
+
+
+def test_resolve_commands_excludes_system_when_disabled(commands_home):
+    (commands_home / "hello.py").write_text(HELLO_CMD, encoding="utf-8")
+    resolved = resolve_commands(include_system_commands=False)
+    assert set(resolved) == {"hello"}
+    assert "list" not in resolved
+    assert "make" not in resolved
+
+
+def test_resolve_commands_includes_system_when_enabled(commands_home):
+    (commands_home / "hello.py").write_text(HELLO_CMD, encoding="utf-8")
+    resolved = resolve_commands(include_system_commands=True)
+    assert set(resolved) == {"hello", "list", "make"}
+    assert resolved["list"] is ListCommand
+    assert resolved["make"] is MakeCommand
+
+
+def test_resolve_commands_user_overrides_system(commands_home, capsys):
+    (commands_home / "list.py").write_text(
+        """\
+from rhythmos import BaseCommand
+
+class ListCommand(BaseCommand):
+    def get_description(self):
+        return "user list"
+
+    def handle(self):
+        print("user")
+""",
+        encoding="utf-8",
+    )
+    resolved = resolve_commands(include_system_commands=True)
+    assert resolved["list"] is not ListCommand
+    assert resolved["list"] is not SYSTEM_COMMANDS["list"]
+    err = capsys.readouterr().err
+    assert "overrides system command 'list'" in err
+
+
+def test_scaffold_command_writes_stub(commands_home):
+    path = scaffold_command("greet", "Greet someone")
+    assert path == commands_home / "greet.py"
+    text = path.read_text(encoding="utf-8")
+    assert "class GreetCommand" in text
+    assert "Greet someone" in text
+    assert "from rhythmos import BaseCommand" in text
+
+
+def test_scaffold_command_rejects_duplicates(commands_home):
+    scaffold_command("greet")
+    with pytest.raises(FileExistsError):
+        scaffold_command("greet")
+
+
+def test_main_with_system_commands_runs_list(commands_home, capsys):
+    (commands_home / "hello.py").write_text(HELLO_CMD, encoding="utf-8")
+    main(["list"], include_system_commands=True)
+    out = capsys.readouterr().out
+    assert "hello" in out
+    assert "[user" in out
+    assert "[system]" in out
+
+
+def test_main_without_system_commands_rejects_list(commands_home):
+    (commands_home / "hello.py").write_text(HELLO_CMD, encoding="utf-8")
+    with pytest.raises(SystemExit):
+        main(["list"], include_system_commands=False)

rhythmos_cli-26.8.2/src/rhythmos/__init__.py

@@ -1,6 +0,0 @@
-"""Rhythmos — a lightweight project CLI framework."""
-
-from rhythmos.base_command import BaseCommand
-
-__version__ = "0.1.0"
-__all__ = ["BaseCommand", "__version__"]