Skip to main content

Griffe extension for Pydantic.

Project description

griffe-pydantic

ci documentation pypi version gitpod gitter

Griffe extension for Pydantic.

Installation

pip install griffe-pydantic

Usage

Command-line

griffe dump mypackage -e griffe_pydantic

See command-line usage in Griffe's documentation.

Python

import griffe

griffe.load(
    "mypackage",
    extensions=griffe.load_extensions(
        [{"griffe_pydantic": {"schema": True}}]
    )
)

See programmatic usage in Griffe's documentation.

MkDocs

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_pydantic:
              schema: true

See MkDocs usage in Griffe's documentation.

Project details


Download files

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

Source Distribution

griffe_pydantic-1.0.0.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

griffe_pydantic-1.0.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file griffe_pydantic-1.0.0.tar.gz.

File metadata

  • Download URL: griffe_pydantic-1.0.0.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for griffe_pydantic-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a6027bf8ea42ddbd9f7dca4badd29781a6522df9c61af778419e733466cdd7ac
MD5 414b710c97e1a448f0b83dcad62c166b
BLAKE2b-256 9c845dba3b18b8d9fb06276ed2a1f82d3b6d909450f52d79f72c6a5c6abad226

See more details on using hashes here.

File details

Details for the file griffe_pydantic-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for griffe_pydantic-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9697a385aba2eeb12f467fe174b9b6243e4a38aa17031864e892563aa27dd328
MD5 d99bf55057d8659af9dc0876144a510c
BLAKE2b-256 5a96452220998ed3bbdc7a2d7bed72735b341bf3bd5321c245b9d07ff0ed3f29

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page