{"id":13746103,"url":"https://github.com/mkdocstrings/griffe","last_synced_at":"2025-05-09T06:31:23.634Z","repository":{"id":38185366,"uuid":"404879086","full_name":"mkdocstrings/griffe","owner":"mkdocstrings","description":"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.","archived":false,"fork":false,"pushed_at":"2025-04-23T11:33:11.000Z","size":22991,"stargazers_count":442,"open_issues_count":29,"forks_count":49,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-08T09:47:06.363Z","etag":null,"topics":["api","breaking-changes","docs","mkdocstrings-collector","parser","python","signature"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/griffe","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pawamoy","ko_fi":"pawamoy","polar":"pawamoy","custom":["https://www.paypal.me/pawamoy"]}},"created_at":"2021-09-09T21:49:44.000Z","updated_at":"2025-05-08T08:25:48.000Z","dependencies_parsed_at":"2023-10-17T01:22:37.318Z","dependency_job_id":"c6d1e67e-d5ee-4a52-ab9a-f839df12e309","html_url":"https://github.com/mkdocstrings/griffe","commit_stats":{"total_commits":868,"total_committers":30,"mean_commits":"28.933333333333334","dds":"0.11059907834101379","last_synced_commit":"58b17425bace2072664fb654ba1077fb404b92dd"},"previous_names":[],"tags_count":131,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/griffe/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253206069,"owners_count":21871158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","breaking-changes","docs","mkdocstrings-collector","parser","python","signature"],"created_at":"2024-08-03T06:00:46.925Z","updated_at":"2025-05-09T06:31:23.601Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","readme":"# Griffe\n\n[![ci](https://github.com/mkdocstrings/griffe/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe/)\n[![pypi version](https://img.shields.io/pypi/v/griffe.svg)](https://pypi.org/project/griffe/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#mkdocstrings_griffe:gitter.im)\n\n\u003cimg src=\"https://raw.githubusercontent.com/mkdocstrings/griffe/main/logo.svg\" alt=\"Griffe logo, created by François Rozet\" width=\"200\" align=\"right\"\u003e\n\nSignatures 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.\n\nGriffe, pronounced \"grif\" (`/ɡʁif/`), is a french word that means \"claw\",\nbut also \"signature\" in a familiar way. \"On reconnaît bien là sa griffe.\"\n\n- [User guide](https://mkdocstrings.github.io/griffe/guide/users/)\n- [Contributor guide](https://mkdocstrings.github.io/griffe/guide/contributors/)\n- [API reference](https://mkdocstrings.github.io/griffe/reference/api/)\n\n## Installation\n\n```bash\npip install griffe\n```\n\nWith [`uv`](https://docs.astral.sh/uv/):\n\n```bash\nuv tool install griffe\n```\n\n## Usage\n\n### Dump JSON-serialized API\n\n**On the command line**, pass the names of packages to the `griffe dump` command:\n\n```console\n$ griffe dump httpx fastapi\n{\n  \"httpx\": {\n    \"name\": \"httpx\",\n    ...\n  },\n  \"fastapi\": {\n    \"name\": \"fastapi\",\n    ...\n  }\n}\n```\n\nSee the [Serializing chapter](https://mkdocstrings.github.io/griffe/guide/users/serializing/) for more examples.\n\n### Check for API breaking changes\n\nPass a relative path to the `griffe check` command:\n\n```console\n$ griffe check mypackage --verbose\nmypackage/mymodule.py:10: MyClass.mymethod(myparam):\nParameter kind was changed:\n  Old: positional or keyword\n  New: keyword-only\n```\n\nFor `src` layouts:\n\n```console\n$ griffe check --search src mypackage --verbose\nsrc/mypackage/mymodule.py:10: MyClass.mymethod(myparam):\nParameter kind was changed:\n  Old: positional or keyword\n  New: keyword-only\n```\n\nIt's also possible to directly **check packages from PyPI.org**\n(or other indexes configured through `PIP_INDEX_URL`).\nThis feature is [available to sponsors only](https://mkdocstrings.github.io/griffe/insiders/)\nand requires that you install Griffe with the `pypi` extra:\n\n```bash\npip install griffe[pypi]\n```\n\nThe command syntax is:\n\n```bash\ngriffe check package_name -b project-name==2.0 -a project-name==1.0\n```\n\nSee the [Checking chapter](https://mkdocstrings.github.io/griffe/guide/users/checking/) for more examples.\n\n### Load and navigate data with Python\n\n**With Python**, loading a package:\n\n```python\nimport griffe\n\nfastapi = griffe.load(\"fastapi\")\n```\n\nFinding breaking changes:\n\n```python\nimport griffe\n\nprevious = griffe.load_git(\"mypackage\", ref=\"0.2.0\")\ncurrent = griffe.load(\"mypackage\")\n\nfor breakage in griffe.find_breaking_changes(previous, current):\n    ...\n```\n\nSee the [Loading chapter](https://mkdocstrings.github.io/griffe/guide/users/loading/) for more examples.\n","funding_links":["https://github.com/sponsors/pawamoy","https://ko-fi.com/pawamoy","https://polar.sh/pawamoy","https://www.paypal.me/pawamoy"],"categories":["Python","Documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fgriffe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe/lists"}