griffe-pydantic


Namegriffe-pydantic JSON
Version 1.1.2 PyPI version JSON
download
home_pageNone
SummaryGriffe extension for Pydantic.
upload_time2025-02-18 00:13:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseISC
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # griffe-pydantic

[![ci](https://github.com/mkdocstrings/griffe-pydantic/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-pydantic/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-pydantic/)
[![pypi version](https://img.shields.io/pypi/v/griffe-pydantic.svg)](https://pypi.org/project/griffe-pydantic/)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-pydantic:gitter.im)

[Griffe](https://mkdocstrings.github.io/griffe/) extension for [Pydantic](https://github.com/pydantic/pydantic).

## Installation

```bash
pip install griffe-pydantic
```

## Usage

### Command-line

```bash
griffe dump mypackage -e griffe_pydantic
```

See [command-line usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#on-the-command-line).

### Python

```python
import griffe

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

See [programmatic usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#programmatically).

### MkDocs

```yaml title="mkdocs.yml"
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_pydantic:
              schema: true
```


See [MkDocs usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#in-mkdocs).

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "griffe-pydantic",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
    "download_url": "https://files.pythonhosted.org/packages/ca/9e/5242baf6e06adf7e9db6a0ef74728c34885325a461502695acba892a9a2f/griffe_pydantic-1.1.2.tar.gz",
    "platform": null,
    "description": "# griffe-pydantic\n\n[![ci](https://github.com/mkdocstrings/griffe-pydantic/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-pydantic/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-pydantic/)\n[![pypi version](https://img.shields.io/pypi/v/griffe-pydantic.svg)](https://pypi.org/project/griffe-pydantic/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-pydantic:gitter.im)\n\n[Griffe](https://mkdocstrings.github.io/griffe/) extension for [Pydantic](https://github.com/pydantic/pydantic).\n\n## Installation\n\n```bash\npip install griffe-pydantic\n```\n\n## Usage\n\n### Command-line\n\n```bash\ngriffe dump mypackage -e griffe_pydantic\n```\n\nSee [command-line usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#on-the-command-line).\n\n### Python\n\n```python\nimport griffe\n\ngriffe.load(\n    \"mypackage\",\n    extensions=griffe.load_extensions(\n        [{\"griffe_pydantic\": {\"schema\": True}}]\n    )\n)\n```\n\nSee [programmatic usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#programmatically).\n\n### MkDocs\n\n```yaml title=\"mkdocs.yml\"\nplugins:\n- mkdocstrings:\n    handlers:\n      python:\n        options:\n          extensions:\n          - griffe_pydantic:\n              schema: true\n```\n\n\nSee [MkDocs usage in Griffe's documentation](https://mkdocstrings.github.io/griffe/extensions/#in-mkdocs).\n",
    "bugtrack_url": null,
    "license": "ISC",
    "summary": "Griffe extension for Pydantic.",
    "version": "1.1.2",
    "project_urls": {
        "Changelog": "https://mkdocstrings.github.io/griffe-pydantic/changelog",
        "Discussions": "https://github.com/mkdocstrings/griffe-pydantic/discussions",
        "Documentation": "https://mkdocstrings.github.io/griffe-pydantic",
        "Funding": "https://github.com/sponsors/pawamoy",
        "Gitter": "https://gitter.im/mkdocstrings/griffe-pydantic",
        "Homepage": "https://mkdocstrings.github.io/griffe-pydantic",
        "Issues": "https://github.com/mkdocstrings/griffe-pydantic/issues",
        "Repository": "https://github.com/mkdocstrings/griffe-pydantic"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "69bb2f4889c062f91ed809dbd14a2628365fa7f75b7fc3f8ce17d98b726563b0",
                "md5": "e4743d1d155f29cf6a4e049321fc54b5",
                "sha256": "8ad53218ca6e9c24ccec83588eb435f562b30355f641fe336e81b1e00ea05f3c"
            },
            "downloads": -1,
            "filename": "griffe_pydantic-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e4743d1d155f29cf6a4e049321fc54b5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10450,
            "upload_time": "2025-02-18T00:13:25",
            "upload_time_iso_8601": "2025-02-18T00:13:25.714686Z",
            "url": "https://files.pythonhosted.org/packages/69/bb/2f4889c062f91ed809dbd14a2628365fa7f75b7fc3f8ce17d98b726563b0/griffe_pydantic-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ca9e5242baf6e06adf7e9db6a0ef74728c34885325a461502695acba892a9a2f",
                "md5": "161968b718b6014b98b1147d7bc69755",
                "sha256": "381eacd8854a85811522b4f6dc9a1ef0fb5931825081379d70ff3a425b0d4ea1"
            },
            "downloads": -1,
            "filename": "griffe_pydantic-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "161968b718b6014b98b1147d7bc69755",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 38858,
            "upload_time": "2025-02-18T00:13:26",
            "upload_time_iso_8601": "2025-02-18T00:13:26.995101Z",
            "url": "https://files.pythonhosted.org/packages/ca/9e/5242baf6e06adf7e9db6a0ef74728c34885325a461502695acba892a9a2f/griffe_pydantic-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-18 00:13:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mkdocstrings",
    "github_project": "griffe-pydantic",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "griffe-pydantic"
}
None
Elapsed time: 0.77344s