Skip to main content

Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.

Project description

Griffe

ci documentation pypi version gitter

Griffe logo, created by François Rozet <francois.rozet@outlook.com>

Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.

Griffe, pronounced "grif" (/ɡʁif/), is a french word that means "claw", but also "signature" in a familiar way. "On reconnaît bien là sa griffe."

Installation

pip install griffe

With uv:

uv tool install griffe

Usage

Dump JSON-serialized API

On the command line, pass the names of packages to the griffe dump command:

$ griffe dump httpx fastapi
{
  "httpx": {
    "name": "httpx",
    ...
  },
  "fastapi": {
    "name": "fastapi",
    ...
  }
}

See the Serializing chapter for more examples.

Check for API breaking changes

Pass a relative path to the griffe check command:

$ griffe check mypackage --verbose
mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
  Old: positional or keyword
  New: keyword-only

For src layouts:

$ griffe check --search src mypackage --verbose
src/mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
  Old: positional or keyword
  New: keyword-only

It's also possible to directly check packages from PyPI.org (or other indexes configured through PIP_INDEX_URL). This feature is available to sponsors only and requires that you install Griffe with the pypi extra:

pip install griffe[pypi]

The command syntax is:

griffe check package_name -b project-name==2.0 -a project-name==1.0

See the Checking chapter for more examples.

Load and navigate data with Python

With Python, loading a package:

import griffe

fastapi = griffe.load("fastapi")

Finding breaking changes:

import griffe

previous = griffe.load_git("mypackage", ref="0.2.0")
current = griffe.load("mypackage")

for breakage in griffe.find_breaking_changes(previous, current):
    ...

See the Loading chapter for more examples.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

griffe-1.5.7.tar.gz (391.5 kB view details)

Uploaded Source

Built Distribution

griffe-1.5.7-py3-none-any.whl (128.3 kB view details)

Uploaded Python 3

File details

Details for the file griffe-1.5.7.tar.gz.

File metadata

  • Download URL: griffe-1.5.7.tar.gz
  • Upload date:
  • Size: 391.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for griffe-1.5.7.tar.gz
Algorithm Hash digest
SHA256 465238c86deaf1137761f700fb343edd8ffc846d72f6de43c3c345ccdfbebe92
MD5 6cb759375831ab07401c26175f1c7038
BLAKE2b-256 598013b6456bfbf8bc854875e58d3a3bad297ee19ebdd693ce62a10fab007e7a

See more details on using hashes here.

File details

Details for the file griffe-1.5.7-py3-none-any.whl.

File metadata

  • Download URL: griffe-1.5.7-py3-none-any.whl
  • Upload date:
  • Size: 128.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for griffe-1.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4af8ec834b64de954d447c7b6672426bb145e71605c74a4e22d510cc79fe7d8b
MD5 071ca61ce689448e47a9eee345434ec8
BLAKE2b-256 7667b43330ed76f96be098c165338d47ccb952964ed77ba1d075247fbdf05c04

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page