Metadata-Version: 2.1
Name: griffe-tui
Version: 1.0.0
Summary: A textual user interface for Griffe.
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
License: ISC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
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: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-tui
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-tui
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-tui/changelog
Project-URL: Repository, https://github.com/mkdocstrings/griffe-tui
Project-URL: Issues, https://github.com/mkdocstrings/griffe-tui/issues
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-tui/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-tui
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.9
Requires-Dist: textual>=0.36
Requires-Dist: griffe2md>=1.0.1
Requires-Dist: importlib-metadata>=4.6; python_version < "3.10"
Description-Content-Type: text/markdown

# Griffe TUI

[![ci](https://github.com/mkdocstrings/griffe-tui/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-tui/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-tui/)
[![pypi version](https://img.shields.io/pypi/v/griffe-tui.svg)](https://pypi.org/project/griffe-tui/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-tui)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-tui:gitter.im)

A textual user interface for Griffe.
100% offline, beautiful Python API docs, in your terminal,
thanks to [Griffe](https://github.com/mkdocstrings/griffe)
and [Textual](https://github.com/Textualize/textual).

![griffetui](https://raw.githubusercontent.com/mkdocstrings/griffe-tui/gh-pages/img/screenshot.png)

## Installation

```bash
pip install griffe-tui
```

With [`uv`](https://docs.astral.sh/uv/):

```bash
uv tool install griffe-tui
```

## Usage

Simply run `griffe-tui` in your terminal:

```bash
griffe-tui
```

And enjoy the TUI!
