griffe-pydantic
Griffe extension for Pydantic.
Decision gist · record as of 2026-08-14
Yes, if you use Pydantic models and generate API documentation with Griffe or MkDocs. The extension is actively maintained, has low install friction, carries a permissive license, and solves a real documentation gap. Install it when you need Pydantic schemas to appear in your generated docs; skip it if you don't use Pydantic or don't use Griffe for documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low friction install with a single runtime dependency (griffelib).
- Active maintenance with recent commits and Beta-stage stability.
License · maintenance · safety
ISC (permissive) — ISC license is permissive and imposes minimal restrictions on use, modification, or distribution.
last release 2026-02-20 (175 days) · last repo commit 2026-02-21 · 27 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 305,547 downloads/mo, #7,794 on PyPI
Alternatives
Verify before relying
pip install griffe-pydantic
import griffe
griffe.load(
"mypackage",
extensions=griffe.load_extensions(
[{"griffe_pydantic": {"schema": True}}]
)
)- Whether schema extraction works with all Pydantic v1 and v2 model types or has known limitations.
- Performance impact when processing packages with many Pydantic models.
- Compatibility with specific Griffe versions beyond the runtime dependency.
What it is and what it does
griffe-pydantic is a plugin that teaches Griffe, a Python API documentation extraction tool, how to understand and document Pydantic models. When you run Griffe on a codebase containing Pydantic classes, this extension automatically extracts their schemas and field definitions, making them visible in your generated documentation. It works at three levels: as a command-line flag to `griffe dump`, as a programmatic extension when loading packages in Python, and as a plugin configuration in MkDocs documentation builds.
The extension is designed for teams using Pydantic for data validation and serialization who want their model schemas to appear automatically in their API docs. It integrates cleanly into existing Griffe workflows without requiring manual schema documentation. The package is actively maintained, supports modern Python versions (3.10 through 3.14), and has no known security vulnerabilities.
Use it for
- Generate API documentation that includes Pydantic model field types and validation rules automatically.
- Build MkDocs documentation sites where Pydantic schemas appear alongside class docstrings.
- Extract and display Pydantic model structure programmatically for code introspection tools.
- Maintain accurate schema documentation without duplicating Pydantic model definitions in docs.
- Integrate Pydantic schema discovery into CI/CD documentation generation pipelines.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use Pydantic models and generate API documentation with Griffe or MkDocs.
The extension is actively maintained, has low install friction, carries a permissive license, and solves a real documentation gap. Install it when you need Pydantic schemas to appear in your generated docs; skip it if you don't use Pydantic or don't use Griffe for documentation.
Install
griffe-pydantic on PyPI
Before you install
Low friction install with a single runtime dependency (griffelib). Active maintenance with recent commits and Beta-stage stability.
Requires Python 3.10 or later.
License in practice
ISC license is permissive and imposes minimal restrictions on use, modification, or distribution.
Quickstart
pip install griffe-pydantic
import griffe
griffe.load(
"mypackage",
extensions=griffe.load_extensions(
[{"griffe_pydantic": {"schema": True}}]
)
)Verify before relying
- Whether schema extraction works with all Pydantic v1 and v2 model types or has known limitations.
- Performance impact when processing packages with many Pydantic models.
- Compatibility with specific Griffe versions beyond the runtime dependency.
Package facts
| License | ISC permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagegriffelib |
| Maintenance | Actively maintained 175 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 305,547 / month, #7,794 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software DevelopmentTopic :: UtilitiesTyping :: Typed |
Evidence: griffe_pydantic-1.3.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “pydantic schema documentation”
- griffe-pydanticExtends Griffe to automatically extract and document Pydantic model…
- quart-schemaQuart-Schema adds schema validation and auto-generated OpenAPI…
- flask-pydantic-specAdds OpenAPI documentation generation and request/response validation…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also griffe2md · griffe-warnings-deprecated · griffe-typingdoc · griffe · mkdocstrings-python · haystack-pydoc-tools · dydantic · mkdocs-api-autonav · openapi-pydantic · mkdocstrings