magicli 2.1.3__tar.gz → 2.1.4__tar.gz

{magicli-2.1.3 → magicli-2.1.4}/.github/workflows/lint.yml

@@ -1,6 +1,7 @@
 name: Lint
 
 on:
+  workflow_dispatch:
   pull_request:
     paths:
       - magicli.py
@@ -9,8 +10,8 @@ jobs:
   flake8:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           cache-dependency-glob: ""
       - run: uv run --with flake8 flake8 magicli.py --extend-ignore=E203,E501
@@ -18,8 +19,8 @@ jobs:
   pylint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           cache-dependency-glob: ""
       - run: uv run --with pylint pylint magicli.py
@@ -27,8 +28,8 @@ jobs:
   ruff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           cache-dependency-glob: ""
       - run: uv run --with ruff ruff format magicli.py --diff
@@ -36,8 +37,8 @@ jobs:
   isort:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           cache-dependency-glob: ""
       - run: uv run --with isort isort --check --diff magicli.py

{magicli-2.1.3 → magicli-2.1.4}/.github/workflows/pytest.yml

@@ -1,6 +1,7 @@
 name: Pytest
 
 on:
+  workflow_dispatch:
   pull_request:
     paths:
       - "**/*.py"
@@ -13,8 +14,8 @@ jobs:
       matrix:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v5
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           cache-dependency-glob: ""
           python-version: ${{ matrix.python-version }}

{magicli-2.1.3 → magicli-2.1.4}/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v3
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.1.0
       - run: uv build
       - run: uv publish --trusted-publishing always

{magicli-2.1.3 → magicli-2.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.3
+Version: 2.1.4
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later
@@ -13,70 +13,64 @@ Dynamic: license-file
 
 # magiᴄʟɪ✨
 
-Automatically generates a CLI from functions of a module.
+Automatically turns a file into a CLI without any boilerplate by introspecting its functions.
 
-## Install
+**`hello world` example**
 
-```
-pip install magicli
+```python
+# hello.py
+def hello(name, greeting="hello"):
+    print(greeting, name)
 ```
 
-## Get started
+becomes
 
-Simple usage example.
+<img src="docs/img/hello.svg"/>
 
-```python
-# module.py
-def hello(name, times=1):
-    for _ in range(times):
-        print("hello", name)
-```
+with only 3 commands
 
-Then run this in your terminal to initialize the CLI:
+1. `pip install magicli`
+1. `magicli`
+1. `pip install .`
 
-```bash
-magicli
-```
+## Quick start
 
-You are now able to install your package:
+### Install magicli
 
-```bash
-pip install .
+```
+pip install magicli
 ```
 
-And then call it:
+### Setup your repository
+
+Initialize repo
 
 ```bash
-$ hello world --times 2
-hello world
-hello world
+git init
 ```
 
-### Define name of CLI in `pyproject.toml`
+Add version info (optional)
 
-The terminal command `magicli` adds the following to your `pyproject.toml`.
-
-```toml
-[project.scripts]
-hello = "magicli:magicli"
+```bash
+git tag 1.0.0
 ```
 
-Important: Make sure the name of your CLI, the module name and the name of the function to be called are the same!
+### Automatically create CLI
 
 ```bash
-.
-├── hello.py
-└── pyproject.toml
+magicli
 ```
 
-You can now `pip install` your code and call it like this:
+_Make sure the name of your CLI, the module name and the name of the function have to same name._
+
+### Install your Python package
 
 ```bash
-$ hello world --times 2
-hello world
-hello world
+pip install .
 ```
 
+## Advanced use
+
 ### Using subcommands
 
 ```python

magicli-2.1.4/README.md

@@ -0,0 +1,90 @@
+# magiᴄʟɪ✨
+
+Automatically turns a file into a CLI without any boilerplate by introspecting its functions.
+
+**`hello world` example**
+
+```python
+# hello.py
+def hello(name, greeting="hello"):
+    print(greeting, name)
+```
+
+becomes
+
+<img src="docs/img/hello.svg"/>
+
+with only 3 commands
+
+1. `pip install magicli`
+1. `magicli`
+1. `pip install .`
+
+## Quick start
+
+### Install magicli
+
+```
+pip install magicli
+```
+
+### Setup your repository
+
+Initialize repo
+
+```bash
+git init
+```
+
+Add version info (optional)
+
+```bash
+git tag 1.0.0
+```
+
+### Automatically create CLI
+
+```bash
+magicli
+```
+
+_Make sure the name of your CLI, the module name and the name of the function have to same name._
+
+### Install your Python package
+
+```bash
+pip install .
+```
+
+## Advanced use
+
+### Using subcommands
+
+```python
+# module.py
+def hello(): ...
+
+def world(times=1):
+    for _ in range(times):
+        print("hello world")
+```
+
+```bash
+$ hello world --times 2
+hello world
+hello world
+```
+
+### Help message
+
+By default, the docstring of the function will be displayed.
+
+If no docstring is specified, an error message will be printed.
+
+## Development
+
+Run pytest with coverage report:
+
+```bash
+python3 -m pytest -s --cov=magicli --cov-report=term-missing
+```

magicli-2.1.4/docs/img/hello.svg

@@ -0,0 +1 @@
+<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.3 → magicli-2.1.4}/magicli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: magicli
-Version: 2.1.3
+Version: 2.1.4
 Summary: Automatically generates a CLI from functions.
 Author-email: Patrick Elmer <patrick@elmer.ws>
 License-Expression: GPL-3.0-or-later
@@ -13,70 +13,64 @@ Dynamic: license-file
 
 # magiᴄʟɪ✨
 
-Automatically generates a CLI from functions of a module.
+Automatically turns a file into a CLI without any boilerplate by introspecting its functions.
 
-## Install
+**`hello world` example**
 
-```
-pip install magicli
+```python
+# hello.py
+def hello(name, greeting="hello"):
+    print(greeting, name)
 ```
 
-## Get started
+becomes
 
-Simple usage example.
+<img src="docs/img/hello.svg"/>
 
-```python
-# module.py
-def hello(name, times=1):
-    for _ in range(times):
-        print("hello", name)
-```
+with only 3 commands
 
-Then run this in your terminal to initialize the CLI:
+1. `pip install magicli`
+1. `magicli`
+1. `pip install .`
 
-```bash
-magicli
-```
+## Quick start
 
-You are now able to install your package:
+### Install magicli
 
-```bash
-pip install .
+```
+pip install magicli
 ```
 
-And then call it:
+### Setup your repository
+
+Initialize repo
 
 ```bash
-$ hello world --times 2
-hello world
-hello world
+git init
 ```
 
-### Define name of CLI in `pyproject.toml`
+Add version info (optional)
 
-The terminal command `magicli` adds the following to your `pyproject.toml`.
-
-```toml
-[project.scripts]
-hello = "magicli:magicli"
+```bash
+git tag 1.0.0
 ```
 
-Important: Make sure the name of your CLI, the module name and the name of the function to be called are the same!
+### Automatically create CLI
 
 ```bash
-.
-├── hello.py
-└── pyproject.toml
+magicli
 ```
 
-You can now `pip install` your code and call it like this:
+_Make sure the name of your CLI, the module name and the name of the function have to same name._
+
+### Install your Python package
 
 ```bash
-$ hello world --times 2
-hello world
-hello world
+pip install .
 ```
 
+## Advanced use
+
 ### Using subcommands
 
 ```python

{magicli-2.1.3 → magicli-2.1.4}/magicli.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ 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.3 → magicli-2.1.4}/magicli.py

@@ -15,6 +15,7 @@ from importlib import metadata
 from pathlib import Path
 
 logging.basicConfig(level=os.getenv("MAGICLI_LOG_LEVEL", "DEBUG"), format="%(message)s")
+logger = logging.getLogger(__name__)
 
 
 class ParseArgvError(Exception):
@@ -209,7 +210,7 @@ def check_for_version(argv, parameters, docstring, module):
         "-V": "-V, --version",
     }
     if (doc := args.get(argv[0])) and doc in docstring:
-        logging.info(get_version(module))
+        logger.info(get_version(module))
         raise SystemExit
 
 
@@ -387,9 +388,9 @@ def cli(name="", author="", email="", description="", homepage=""):
         author = author or get_output("git config --get user.name")
         email = email or get_output("git config --get user.email")
         if not get_output("git tag"):
-            logging.debug("Specify the version with `git tag`")
+            logger.debug("Specify the version with `git tag`")
     else:
-        logging.debug("Not a git repo. Run `git init`")
+        logger.debug("Not a git repo. Run `git init`")
 
     authors = [f'{k}="{v}"' for k, v in {"name": author, "email": email}.items() if v]
 
@@ -411,7 +412,7 @@ def cli(name="", author="", email="", description="", homepage=""):
         if license_expression := get_license_expression(license_content):
             project.append(f'license = "{license_expression}"')
         else:
-            logging.debug("Unknown license: %s", license_file.name)
+            logger.debug("Unknown license: %s", license_file.name)
         project.append(f'license-files = ["{license_file.name}"]')
 
     if description or (description := get_description(name)):
@@ -431,4 +432,4 @@ def cli(name="", author="", email="", description="", homepage=""):
     )
 
     pyproject.write_text(format_blocks(blocks, sep="\n") + "\n", encoding="utf-8")
-    logging.debug("Created pyproject.toml ✨")
+    logger.debug("Created pyproject.toml ✨")

magicli-2.1.3/README.md

@@ -1,96 +0,0 @@
-# magiᴄʟɪ✨
-
-Automatically generates a CLI from functions of a module.
-
-## Install
-
-```
-pip install magicli
-```
-
-## Get started
-
-Simple usage example.
-
-```python
-# module.py
-def hello(name, times=1):
-    for _ in range(times):
-        print("hello", name)
-```
-
-Then run this in your terminal to initialize the CLI:
-
-```bash
-magicli
-```
-
-You are now able to install your package:
-
-```bash
-pip install .
-```
-
-And then call it:
-
-```bash
-$ hello world --times 2
-hello world
-hello world
-```
-
-### Define name of CLI in `pyproject.toml`
-
-The terminal command `magicli` adds the following to your `pyproject.toml`.
-
-```toml
-[project.scripts]
-hello = "magicli:magicli"
-```
-
-Important: Make sure the name of your CLI, the module name and the name of the function to be called are the same!
-
-```bash
-.
-├── hello.py
-└── pyproject.toml
-```
-
-You can now `pip install` your code and call it like this:
-
-```bash
-$ hello world --times 2
-hello world
-hello world
-```
-
-### Using subcommands
-
-```python
-# module.py
-def hello(): ...
-
-def world(times=1):
-    for _ in range(times):
-        print("hello world")
-```
-
-```bash
-$ hello world --times 2
-hello world
-hello world
-```
-
-### Help message
-
-By default, the docstring of the function will be displayed.
-
-If no docstring is specified, an error message will be printed.
-
-## Development
-
-Run pytest with coverage report:
-
-```bash
-python3 -m pytest -s --cov=magicli --cov-report=term-missing
-```