Metadata-Version: 2.4
Name: typer-helptree
Version: 0.1.3
Summary: Display your entire CLI structure, beautifully. Screenshot ready.
Author-email: George Clayton Bennett <george.bennett@memphistn.gov>
Maintainer-email: George Clayton Bennett <george.bennett@memphistn.gov>
License-Expression: MIT AND AGPL-3.0-or-later
Project-URL: Homepage, https://github.com/city-of-memphis-wastewater/typer-helptree
Project-URL: Repository, https://github.com/city-of-memphis-wastewater/typer-helptree
Project-URL: Issues, https://github.com/city-of-memphis-wastewater/typer-helptree/issues
Project-URL: Changelog, https://raw.githubusercontent.com/city-of-memphis-wastewater/typer-helptree/main/docs/CHANGELOG.md
Keywords: typer,help,treehelp,helptree,rich,cli
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyhabitat>=1.1.26
Requires-Dist: rich>=14.2.0
Requires-Dist: typer>=0.20.0
Dynamic: license-file

# typer-helptree

The `helptree` command can be added to your Typer CLI.

## User story
- **Dev**: *"I want to a screenshot of my CLI structure, to add to my GitHub release and to my README."*

```bash
typer-helptree helptree
```

![Screenshot of the typer-helptree herlptree](https://raw.githubusercontent.com/City-of-Memphis-Wastewater/typer-helptree/main/assets/typer_helptree_v0.1.1.jpg)

## How To 

Use `helptree` in your Typer CLI: 

```python
# src/your_fancy_app/cli.py

# --- Imports ---
import typer
from rich.console import Console
# Import the add_typer_helptree command.
from typer_helptree.helptree import add_typer_helptree

# --- Typical App Instantiation ---
APP_NAME "your-fancy-app"
console = Console()
app = typer.Typer(
    name=APP_NAME
)

# --- The Magic ---
add_typer_helptree(app = app, console = console)

```

And then, from the command line:

```bash
your-fancy-app helptree
```
---

### Projects that use **typer-helptree*
*
- https://pypi.org/project/pdflinkcheck/
- https://pypi.org/project/dworshak/
