Installation¤

Griffe is a Python package, so you can install it with your favorite Python package installer or dependency manager.

Install as a tool & library¤

pip pdm poetry rye uv

pip install griffe

pip is the main package installer for Python.

pdm add griffe

PDM is an all-in-one solution for Python project management.

poetry add griffe

Poetry is an all-in-one solution for Python project management.

rye add griffe

Rye is an all-in-one solution for Python project management, written in Rust.

uv add griffe

uv is an extremely fast Python package and project manager, written in Rust.

If you only need the library for API introspection and analysis without the CLI tool, you can install griffelib:

pip pdm poetry rye uv

pip install griffelib

pip is the main package installer for Python.

pdm add griffelib

PDM is an all-in-one solution for Python project management.

poetry add griffelib

Poetry is an all-in-one solution for Python project management.

rye add griffelib

Rye is an all-in-one solution for Python project management, written in Rust.

uv add griffelib

uv is an extremely fast Python package and project manager, written in Rust.

This installs the griffe package as usual, but without the CLI program and its dependencies.

pip pipx rye uv

pip install --user griffe

pip is the main package installer for Python.

pipx install griffe

pipx allows to install and run Python applications in isolated environments.

rye install griffe

Rye is an all-in-one solution for Python project management, written in Rust.

uv tool install griffe

uv is an extremely fast Python package and project manager, written in Rust.

Once installed, you can run Griffe using the griffe command:

$ griffe check mypackage

Or as a Python module:

$ python -m griffe check mypackage