Metadata-Version: 2.1
Name: griffe-modernized-annotations
Version: 1.0.8
Summary: A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604
Home-page: https://github.com/jonghwanhyeon/griffe-modernized-annotations
Author: Jonghwan Hyeon
Author-email: jonghwanhyeon93@gmail.com
License: MIT
Keywords: griffe,typing,annotations,pep585,pep604
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: griffe
Requires-Dist: typing-extensions
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: rich ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'

# 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
```
