griffe-modernized-annotations

Name	griffe-modernized-annotations JSON
Version	1.0.6 JSON
	download
home_page	https://github.com/jonghwanhyeon/griffe-modernized-annotations
Summary	A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604
upload_time	2024-08-05 09:09:16
maintainer	None
docs_url	None
author	Jonghwan Hyeon
requires_python	>=3.8
license	MIT
keywords	griffe typing annotations pep585 pep604
VCS
bugtrack_url
requirements	griffe typing-extensions
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # griffe-modernized-annotations
![Build status](https://github.com/jonghwanhyeon/griffe-modernized-annotations/actions/workflows/publish.yml/badge.svg)

A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604

## Example
Without extension:
![Without Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/without-extension.png)

With extension:
![With Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/with-extension.png)

## Install
To install **griffe-modernized-annotations**, simply use pip:

```console
$ pip install griffe-modernized-annotations
```

## Usage
```yaml
plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - griffe_modernized_annotations
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jonghwanhyeon/griffe-modernized-annotations",
    "name": "griffe-modernized-annotations",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "griffe, typing, annotations, pep585, pep604",
    "author": "Jonghwan Hyeon",
    "author_email": "jonghwanhyeon93@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/83/96/7771846925169618ba71ca680c3764e033d08ae895c29bf77b970c70547f/griffe_modernized_annotations-1.0.6.tar.gz",
    "platform": null,
    "description": "# griffe-modernized-annotations\n![Build status](https://github.com/jonghwanhyeon/griffe-modernized-annotations/actions/workflows/publish.yml/badge.svg)\n\nA Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604\n\n## Example\nWithout extension:\n![Without Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/without-extension.png)\n\nWith extension:\n![With Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/with-extension.png)\n\n## Install\nTo install **griffe-modernized-annotations**, simply use pip:\n\n```console\n$ pip install griffe-modernized-annotations\n```\n\n## Usage\n```yaml\nplugins:\n  - mkdocstrings:\n      handlers:\n        python:\n          options:\n            extensions:\n              - griffe_modernized_annotations\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604",
    "version": "1.0.6",
    "project_urls": {
        "Homepage": "https://github.com/jonghwanhyeon/griffe-modernized-annotations"
    },
    "split_keywords": [
        "griffe",
        " typing",
        " annotations",
        " pep585",
        " pep604"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16aa7427ca3238081669fc14a56950e08d98fea0fdb77c3cb0e3eef8c4aaf2ed",
                "md5": "fbb7d248bb3344e19554183a8e0d778e",
                "sha256": "57780923e04ac4cdeb9f663774d0bb1b7dda7ad8596c23130fca097c64096fd7"
            },
            "downloads": -1,
            "filename": "griffe_modernized_annotations-1.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fbb7d248bb3344e19554183a8e0d778e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12145,
            "upload_time": "2024-08-05T09:09:14",
            "upload_time_iso_8601": "2024-08-05T09:09:14.931452Z",
            "url": "https://files.pythonhosted.org/packages/16/aa/7427ca3238081669fc14a56950e08d98fea0fdb77c3cb0e3eef8c4aaf2ed/griffe_modernized_annotations-1.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "83967771846925169618ba71ca680c3764e033d08ae895c29bf77b970c70547f",
                "md5": "5e45c6d7c2e71599f12fbe8a6fe02927",
                "sha256": "bc887749293c59f3614ac2a203293beb380da59498f2d2e475ae0a873b2cd5f3"
            },
            "downloads": -1,
            "filename": "griffe_modernized_annotations-1.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5e45c6d7c2e71599f12fbe8a6fe02927",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8385,
            "upload_time": "2024-08-05T09:09:16",
            "upload_time_iso_8601": "2024-08-05T09:09:16.338930Z",
            "url": "https://files.pythonhosted.org/packages/83/96/7771846925169618ba71ca680c3764e033d08ae895c29bf77b970c70547f/griffe_modernized_annotations-1.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-05 09:09:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jonghwanhyeon",
    "github_project": "griffe-modernized-annotations",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "griffe",
            "specs": []
        },
        {
            "name": "typing-extensions",
            "specs": []
        }
    ],
    "lcname": "griffe-modernized-annotations"
}