usecli 0.1.21__tar.gz

usecli-0.1.21/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edward Boswell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

usecli-0.1.21/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: usecli
+Version: 0.1.21
+Summary: A powerful Python CLI framework for building beautiful, developer-friendly command-line tools.
+Author: Edward Boswell
+Author-email: Edward Boswell <thememium@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Dist: case-converter>=1.2.0
+Requires-Dist: click>=8.3.1
+Requires-Dist: fzf-bin>=0.67.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.3.1
+Requires-Dist: simple-term-menu>=1.6.6
+Requires-Dist: tomli>=2.4.0
+Requires-Dist: typer>=0.21.1
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/thememium/usecli
+Project-URL: Documentation, https://github.com/thememium/usecli
+Project-URL: Repository, https://github.com/thememium/usecli.git
+Project-URL: Issues, https://github.com/thememium/usecli/issues
+Project-URL: Changelog, https://github.com/thememium/usecli/blob/master/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+<a name="readme-top"></a>
+
+<div align="center">
+  <a href="https://github.com/thememium/usecli">
+    <img src="https://raw.githubusercontent.com/thememium/usecli/refs/heads/master/docs/images/usecli-logo-dark-bg.png" alt="useCli" width="360" height="162">
+  </a>
+
+  <p align="center">
+    <a href="#table-of-contents"><strong>Explore the Documentation »</strong></a>
+    <br />
+    <a href="https://github.com/thememium/usecli/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/thememium/usecli/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+
+<a name="table-of-contents"></a>
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about">About</a></li>
+    <li><a href="#quick-start">Quick Start</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#development">Development</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT -->
+
+## About
+
+useCli is a CLI framework for Python. It gives you:
+
+- **Prefix matching** — Type `he` instead of `help`
+- **Interactive mode** — Fuzzy finder for commands
+- **Auto-generated help** — Clean, styled output
+- **Command scaffolding** — `make:command` generates boilerplate
+- **UI components** — Prompts, menus, styled console output
+
+Built on Typer and Click.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- QUICK START -->
+
+## Quick Start
+
+```sh
+# Install
+uv add "usecli @ git+https://github.com/thememium/usecli.git"
+
+# Initialize
+usecli init
+
+# Create a command
+usecli make:command hello
+```
+
+Your new command is ready in the commands directory:
+
+```python
+class HelloCommand(BaseCommand):
+    def signature(self) -> str:
+        return "hello"
+
+    def description(self) -> str:
+        return "Say hello"
+
+    def handle(self, name: str = Argument(..., help="Your name")) -> None:
+        console.print(f"Hello, {name}!")
+```
+
+Run it:
+
+```sh
+usecli hello world
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE -->
+
+## Usage
+
+### Prefix Matching
+
+Type partial command names:
+
+```sh
+usecli he          # help
+usecli ma:co       # make:command
+```
+
+### Interactive Mode
+
+```sh
+usecli --interactive    # Fuzzy finder for all commands
+usecli -i hello         # Run 'hello' command interactively
+```
+
+### Command Groups
+
+Colon-separated commands group automatically in help:
+
+```python
+def signature(self) -> str:
+    return "db:migrate"
+```
+
+Displays as:
+
+```
+db:
+  migrate    Run migrations
+  backup     Backup database
+```
+
+Space-separated signatures create nested subcommands:
+
+```python
+def signature(self) -> str:
+    return "spec show"   # usecli spec show
+```
+
+### UI Components
+
+```python
+from usecli import console, Prompt, Confirm, Menu
+
+console.print("[green]Done![/green]")
+name = Prompt.ask("Enter name")
+ok = Confirm.ask("Continue?")
+choice = Menu(["A", "B", "C"]).show()
+```
+
+### Available Commands
+
+```
+about        Show app info
+help         Show help
+init         Initialize usecli
+inspire      Random quote
+make:command Create new command
+```
+
+### Hiding Built-in Commands
+
+```toml
+[tool.usecli]
+hide_init = true
+hide_inspire = true
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- DEVELOPMENT -->
+
+## Development
+
+See the [Development Guide](docs/development.md) for setup, testing, and architecture details.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Read the [Contributing Guide](.github/contributing.md).
+
+Quick workflow:
+
+1. Fork and branch: `git checkout -b feature/name`
+2. Make changes
+3. Run checks: `uv run poe clean-full`
+4. Commit and push
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+MIT. See `LICENSE`.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+---
+
+<div align="center">
+  <p>
+    <sub>Built by <a href="https://github.com/thememium">thememium</a></sub>
+  </p>
+</div>

usecli-0.1.21/README.md

@@ -0,0 +1,199 @@
+<a name="readme-top"></a>
+
+<div align="center">
+  <a href="https://github.com/thememium/usecli">
+    <img src="https://raw.githubusercontent.com/thememium/usecli/refs/heads/master/docs/images/usecli-logo-dark-bg.png" alt="useCli" width="360" height="162">
+  </a>
+
+  <p align="center">
+    <a href="#table-of-contents"><strong>Explore the Documentation »</strong></a>
+    <br />
+    <a href="https://github.com/thememium/usecli/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/thememium/usecli/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+
+<a name="table-of-contents"></a>
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about">About</a></li>
+    <li><a href="#quick-start">Quick Start</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#development">Development</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT -->
+
+## About
+
+useCli is a CLI framework for Python. It gives you:
+
+- **Prefix matching** — Type `he` instead of `help`
+- **Interactive mode** — Fuzzy finder for commands
+- **Auto-generated help** — Clean, styled output
+- **Command scaffolding** — `make:command` generates boilerplate
+- **UI components** — Prompts, menus, styled console output
+
+Built on Typer and Click.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- QUICK START -->
+
+## Quick Start
+
+```sh
+# Install
+uv add "usecli @ git+https://github.com/thememium/usecli.git"
+
+# Initialize
+usecli init
+
+# Create a command
+usecli make:command hello
+```
+
+Your new command is ready in the commands directory:
+
+```python
+class HelloCommand(BaseCommand):
+    def signature(self) -> str:
+        return "hello"
+
+    def description(self) -> str:
+        return "Say hello"
+
+    def handle(self, name: str = Argument(..., help="Your name")) -> None:
+        console.print(f"Hello, {name}!")
+```
+
+Run it:
+
+```sh
+usecli hello world
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE -->
+
+## Usage
+
+### Prefix Matching
+
+Type partial command names:
+
+```sh
+usecli he          # help
+usecli ma:co       # make:command
+```
+
+### Interactive Mode
+
+```sh
+usecli --interactive    # Fuzzy finder for all commands
+usecli -i hello         # Run 'hello' command interactively
+```
+
+### Command Groups
+
+Colon-separated commands group automatically in help:
+
+```python
+def signature(self) -> str:
+    return "db:migrate"
+```
+
+Displays as:
+
+```
+db:
+  migrate    Run migrations
+  backup     Backup database
+```
+
+Space-separated signatures create nested subcommands:
+
+```python
+def signature(self) -> str:
+    return "spec show"   # usecli spec show
+```
+
+### UI Components
+
+```python
+from usecli import console, Prompt, Confirm, Menu
+
+console.print("[green]Done![/green]")
+name = Prompt.ask("Enter name")
+ok = Confirm.ask("Continue?")
+choice = Menu(["A", "B", "C"]).show()
+```
+
+### Available Commands
+
+```
+about        Show app info
+help         Show help
+init         Initialize usecli
+inspire      Random quote
+make:command Create new command
+```
+
+### Hiding Built-in Commands
+
+```toml
+[tool.usecli]
+hide_init = true
+hide_inspire = true
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- DEVELOPMENT -->
+
+## Development
+
+See the [Development Guide](docs/development.md) for setup, testing, and architecture details.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Read the [Contributing Guide](.github/contributing.md).
+
+Quick workflow:
+
+1. Fork and branch: `git checkout -b feature/name`
+2. Make changes
+3. Run checks: `uv run poe clean-full`
+4. Commit and push
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+MIT. See `LICENSE`.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+---
+
+<div align="center">
+  <p>
+    <sub>Built by <a href="https://github.com/thememium">thememium</a></sub>
+  </p>
+</div>

usecli-0.1.21/pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "usecli"
+version = "0.1.21"
+description = "A powerful Python CLI framework for building beautiful, developer-friendly command-line tools."
+readme = "README.md"
+authors = [{ name = "Edward Boswell", email = "thememium@gmail.com" }]
+requires-python = ">=3.10"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Intended Audience :: Developers",
+]
+dependencies = [
+  "case-converter>=1.2.0",
+  "click>=8.3.1",
+  "fzf-bin>=0.67.0",
+  "jinja2>=3.1.6",
+  "pyfiglet>=1.0.4",
+  "pyyaml>=6.0.2",
+  "rich>=14.3.1",
+  "simple-term-menu>=1.6.6",
+  "tomli>=2.4.0",
+  "typer>=0.21.1",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/thememium/usecli"
+Documentation = "https://github.com/thememium/usecli"
+Repository = "https://github.com/thememium/usecli.git"
+Issues = "https://github.com/thememium/usecli/issues"
+Changelog = "https://github.com/thememium/usecli/blob/master/CHANGELOG.md"
+
+[project.scripts]
+usecli = "usecli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.2,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+  "deptry>=0.24.0",
+  "isort>=7.0.0",
+  "poethepoet>=0.41.0",
+  "pytest>=9.0.2",
+  "ruff>=0.15.1",
+  "ty>=0.0.17",
+]
+
+[tool.deptry]
+known_first_party = ["usecli"]
+
+[tool.deptry.package_module_name_map]
+case-converter = "caseconverter"
+
+[tool.deptry.per_rule_ignores]
+DEP002 = ["fzf-bin"]
+
+[tool.poe.tasks]
+dev = "uv run usecli"
+clean-full = "sh -c 'uv run isort . && uv run ruff check . && uv run ruff format . && uv run deptry . && uv run ty check'"
+clean = "sh -c 'uv run isort . && uv run ruff format .'"
+test = "uv run pytest tests/ -v"
+sort = "uv run isort ."
+lint = "uv run ruff check ."
+format = "uv run ruff format ."
+deptry = "uv deptry ."
+typecheck = "uv run ty check"
+build = "uv build --no-sources"
+release = "bash scripts/release.sh"
+
+[tool.ty]
+
+[tool.ty.src]
+include = ["src", "tests"]
+exclude = ["**/__pycache__", "**/.venv"]
+
+[tool.ty.rules]
+# Ty uses rule = "level" format (error, warn, ignore)
+# See all rules at: https://docs.astral.sh/ty/reference/rules/
+
+[tool.usecli]
+theme = "default"
+commands_dir = "src/usecli/cli/commands/custom"
+templates_dir = "src/usecli/cli/templates"
+themes_dir = "src/usecli/cli/themes"
+hide_init = false
+hide_inspire = false
+hide_make_command = false