magicli 2.1.6__tar.gz → 2.2.0__tar.gz

{magicli-2.1.6 → magicli-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.6
+Version: 2.2.0
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later
@@ -36,7 +36,7 @@ def hello(name, greeting="hello"):
 
 calling `magicli` creates this CLI:
 
-![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/main/docs/img/hello.svg)
+![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/assets/img/hello.svg)
 
 (animated terminal created with [clivio](patrickelmer.github.io/clivio))
 

{magicli-2.1.6 → magicli-2.2.0}/README.md

@@ -23,7 +23,7 @@ def hello(name, greeting="hello"):
 
 calling `magicli` creates this CLI:
 
-![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/main/docs/img/hello.svg)
+![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/assets/img/hello.svg)
 
 (animated terminal created with [clivio](patrickelmer.github.io/clivio))
 

{magicli-2.1.6 → magicli-2.2.0}/magicli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.6
+Version: 2.2.0
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later
@@ -36,7 +36,7 @@ def hello(name, greeting="hello"):
 
 calling `magicli` creates this CLI:
 
-![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/main/docs/img/hello.svg)
+![hello world example](https://raw.githubusercontent.com/PatrickElmer/magicli/refs/heads/assets/img/hello.svg)
 
 (animated terminal created with [clivio](patrickelmer.github.io/clivio))
 

{magicli-2.1.6 → magicli-2.2.0}/magicli.egg-info/SOURCES.txt

@@ -6,7 +6,6 @@ pyproject.toml
 .github/workflows/lint.yml
 .github/workflows/pytest.yml
 .github/workflows/release.yml
-docs/img/hello.svg
 magicli.egg-info/PKG-INFO
 magicli.egg-info/SOURCES.txt
 magicli.egg-info/dependency_links.txt

{magicli-2.1.6 → magicli-2.2.0}/magicli.egg-info/scm_file_list.json

@@ -5,7 +5,6 @@
     "pyproject.toml",
     "magicli.py",
     ".gitignore",
-    "docs/img/hello.svg",
     "tests/fixtures.py",
     "tests/test_magicli.py",
     "tests/test_parse_kwarg.py",

magicli-2.2.0/magicli.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.2.0",
+  "distance": 0,
+  "node": "g9ecfd3ba03f51320894c356880a12e05ddf3f9cb",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-06-24"
+}

{magicli-2.1.6 → magicli-2.2.0}/magicli.py

@@ -70,7 +70,7 @@ def call(function, argv, module=None, name=None):
     docstring = inspect.getdoc(function) or ""
     parameters = inspect.signature(function).parameters
 
-    check_for_version(argv, parameters, docstring, module)
+    check_for_help_and_version(argv, parameters, docstring, module, function)
 
     try:
         args, kwargs = parse_argv(argv, parameters, docstring)
@@ -200,16 +200,19 @@ def get_type(parameter):
     return str
 
 
-def check_for_version(argv, parameters, docstring, module):
+def check_for_help_and_version(argv, parameters, docstring, module, function):
     """Displays version information if --version is specified in the docstring."""
-    if "version" in parameters or not module or len(argv) != 1:
+    if not module or len(argv) != 1:
         return
+    if argv[0] in ("--help", "-h") and "help" not in parameters:
+        logger.info(help_message(help_from_function, function, None, module))
+        raise SystemExit
     args = {
         "--version": "--version",
         "-v": "-v, --version",
         "-V": "-V, --version",
     }
-    if (doc := args.get(argv[0])) and doc in docstring:
+    if (doc := args.get(argv[0])) and doc in docstring and "version" not in parameters:
         logger.info(get_version(module))
         raise SystemExit
 

{magicli-2.1.6 → magicli-2.2.0}/tests/test_magicli.py

@@ -141,3 +141,18 @@ commands:
   command
   command_2\
 """
+
+@mock.patch("importlib.import_module", side_effect=module)
+def test_help_kwarg_displays_help_message(mocked, caplog):
+    sys.argv = ["name", "--help"]
+    name.__doc__ = None
+    with pytest.raises(SystemExit):
+        magicli()
+    doc = """usage:
+  name
+  name <command>
+
+commands:
+  command"""
+    assert caplog.messages[0] != name.__doc__
+    assert caplog.messages[0] == doc

magicli-2.1.6/docs/img/hello.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="540" height="222" font-family="monospace" font-size="18px" fill="#ffffff"><rect width="100%" height="100%" rx="10" fill="#151b23" /><g transform="scale(0.9) translate(20 38)"><text y="0" opacity="0" style="user-select: none;">$ <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0;0;1;1" dur="11s" repeatCount="indefinite" /></text><text x="21.6" y="0" opacity="0">h<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.0545;0.0545;1;1" dur="11s" repeatCount="indefinite" /></text><text x="32.400000000000006" y="0" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.0636;0.0636;1;1" dur="11s" repeatCount="indefinite" /></text><text x="43.2" y="0" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.0727;0.0727;1;1" dur="11s" repeatCount="indefinite" /></text><text x="54" y="0" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.0818;0.0818;1;1" dur="11s" repeatCount="indefinite" /></text><text x="64.80000000000001" y="0" opacity="0">o<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.0909;0.0909;1;1" dur="11s" repeatCount="indefinite" /></text><text x="75.60000000000001" y="0" opacity="0"> <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1;0.1;1;1" dur="11s" repeatCount="indefinite" /></text><text x="86.4" y="0" opacity="0">w<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1091;0.1091;1;1" dur="11s" repeatCount="indefinite" /></text><text x="97.2" y="0" opacity="0">o<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1182;0.1182;1;1" dur="11s" repeatCount="indefinite" /></text><text x="108" y="0" opacity="0">r<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1273;0.1273;1;1" dur="11s" repeatCount="indefinite" /></text><text x="118.80000000000001" y="0" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1364;0.1364;1;1" dur="11s" repeatCount="indefinite" /></text><text x="129.60000000000002" y="0" opacity="0">d<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1455;0.1455;1;1" dur="11s" repeatCount="indefinite" /></text><text y="23" opacity="0">hello&#160;world<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1545;0.1545;1;1" dur="11s" repeatCount="indefinite" /></text><text y="46" opacity="0" style="user-select: none;">$ <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.1545;0.1545;1;1" dur="11s" repeatCount="indefinite" /></text><text x="21.6" y="46" opacity="0">h<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3455;0.3455;1;1" dur="11s" repeatCount="indefinite" /></text><text x="32.400000000000006" y="46" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3545;0.3545;1;1" dur="11s" repeatCount="indefinite" /></text><text x="43.2" y="46" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3636;0.3636;1;1" dur="11s" repeatCount="indefinite" /></text><text x="54" y="46" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3727;0.3727;1;1" dur="11s" repeatCount="indefinite" /></text><text x="64.80000000000001" y="46" opacity="0">o<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3818;0.3818;1;1" dur="11s" repeatCount="indefinite" /></text><text y="69" opacity="0">name:&#160;positional&#160;argument&#160;missing<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3909;0.3909;1;1" dur="11s" repeatCount="indefinite" /></text><text y="92" opacity="0"><animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3909;0.3909;1;1" dur="11s" repeatCount="indefinite" /></text><text y="115" opacity="0">usage:<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3909;0.3909;1;1" dur="11s" repeatCount="indefinite" /></text><text y="138" opacity="0">&#160;&#160;hello&#160;name&#160;[--greeting]<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3909;0.3909;1;1" dur="11s" repeatCount="indefinite" /></text><text y="161" opacity="0" style="user-select: none;">$ <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.3909;0.3909;1;1" dur="11s" repeatCount="indefinite" /></text><text x="21.6" y="161" opacity="0">h<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.5818;0.5818;1;1" dur="11s" repeatCount="indefinite" /></text><text x="32.400000000000006" y="161" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.5909;0.5909;1;1" dur="11s" repeatCount="indefinite" /></text><text x="43.2" y="161" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6;0.6;1;1" dur="11s" repeatCount="indefinite" /></text><text x="54" y="161" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6091;0.6091;1;1" dur="11s" repeatCount="indefinite" /></text><text x="64.80000000000001" y="161" opacity="0">o<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6182;0.6182;1;1" dur="11s" repeatCount="indefinite" /></text><text x="75.60000000000001" y="161" opacity="0"> <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6273;0.6273;1;1" dur="11s" repeatCount="indefinite" /></text><text x="86.4" y="161" opacity="0">w<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6364;0.6364;1;1" dur="11s" repeatCount="indefinite" /></text><text x="97.2" y="161" opacity="0">o<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6455;0.6455;1;1" dur="11s" repeatCount="indefinite" /></text><text x="108" y="161" opacity="0">r<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6545;0.6545;1;1" dur="11s" repeatCount="indefinite" /></text><text x="118.80000000000001" y="161" opacity="0">l<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6636;0.6636;1;1" dur="11s" repeatCount="indefinite" /></text><text x="129.60000000000002" y="161" opacity="0">d<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6727;0.6727;1;1" dur="11s" repeatCount="indefinite" /></text><text x="140.4" y="161" opacity="0"> <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6818;0.6818;1;1" dur="11s" repeatCount="indefinite" /></text><text x="151.20000000000002" y="161" opacity="0">-<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.6909;0.6909;1;1" dur="11s" repeatCount="indefinite" /></text><text x="162" y="161" opacity="0">-<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7;0.7;1;1" dur="11s" repeatCount="indefinite" /></text><text x="172.8" y="161" opacity="0">g<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7091;0.7091;1;1" dur="11s" repeatCount="indefinite" /></text><text x="183.60000000000002" y="161" opacity="0">r<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7182;0.7182;1;1" dur="11s" repeatCount="indefinite" /></text><text x="194.4" y="161" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7273;0.7273;1;1" dur="11s" repeatCount="indefinite" /></text><text x="205.20000000000002" y="161" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7364;0.7364;1;1" dur="11s" repeatCount="indefinite" /></text><text x="216" y="161" opacity="0">t<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7455;0.7455;1;1" dur="11s" repeatCount="indefinite" /></text><text x="226.8" y="161" opacity="0">i<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7545;0.7545;1;1" dur="11s" repeatCount="indefinite" /></text><text x="237.60000000000002" y="161" opacity="0">n<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7636;0.7636;1;1" dur="11s" repeatCount="indefinite" /></text><text x="248.4" y="161" opacity="0">g<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7727;0.7727;1;1" dur="11s" repeatCount="indefinite" /></text><text x="259.20000000000005" y="161" opacity="0"> <animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7818;0.7818;1;1" dur="11s" repeatCount="indefinite" /></text><text x="270" y="161" opacity="0">b<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.7909;0.7909;1;1" dur="11s" repeatCount="indefinite" /></text><text x="280.8" y="161" opacity="0">y<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.8;0.8;1;1" dur="11s" repeatCount="indefinite" /></text><text x="291.6" y="161" opacity="0">e<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.8091;0.8091;1;1" dur="11s" repeatCount="indefinite" /></text><text y="184" opacity="0">bye&#160;world<animate attributeName="opacity" values="0;0;1;1;0" keyTimes="0;0.8182;0.8182;1;1" dur="11s" repeatCount="indefinite" /></text></g></svg>

magicli-2.1.6/magicli.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "2.1.6",
-  "distance": 0,
-  "node": "g7e30827f02d07921c90e83b73547295a32bd9915",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-06-23"
-}