griffe-generics

Name	griffe-generics JSON
Version	1.0.12 JSON
	download
home_page	https://github.com/jonghwanhyeon/griffe-generics
Summary	A Griffe extension that resolves generic type parameters as bound types in subclasses
upload_time	2024-07-31 06:10:47
maintainer	None
docs_url	None
author	Jonghwan Hyeon
requires_python	>=3.8
license	MIT
keywords	griffe generics generic typing
VCS
bugtrack_url
requirements	griffe typing-extensions
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

A Griffe extension that resolves generic type parameters as bound types in subclasses

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

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

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

```console
$ pip install griffe-generics
```

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jonghwanhyeon/griffe-generics",
    "name": "griffe-generics",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "griffe, generics, generic, typing",
    "author": "Jonghwan Hyeon",
    "author_email": "jonghwanhyeon93@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/7a/0a6a4a222ad549dfe55d194aa905b462b7e3de0b7da842dfd01a572967ef/griffe_generics-1.0.12.tar.gz",
    "platform": null,
    "description": "# griffe-generics\n![Build status](https://github.com/jonghwanhyeon/griffe-generics/actions/workflows/publish.yml/badge.svg)\n\nA Griffe extension that resolves generic type parameters as bound types in subclasses\n\n## Example\nWithout extension:\n![Without Extension](https://github.com/jonghwanhyeon/griffe-generics/raw/main/assets/without-extension.png)\n\nWith extension:\n![With Extension](https://github.com/jonghwanhyeon/griffe-generics/raw/main/assets/without-extension.png)\n\n## Install\nTo install **griffe-generics**, simply use pip:\n\n```console\n$ pip install griffe-generics\n```\n\n## Usage\n```yaml\nplugins:\n  - mkdocstrings:\n      handlers:\n        python:\n          options:\n            extensions:\n              - griffe_generics\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Griffe extension that resolves generic type parameters as bound types in subclasses",
    "version": "1.0.12",
    "project_urls": {
        "Homepage": "https://github.com/jonghwanhyeon/griffe-generics"
    },
    "split_keywords": [
        "griffe",
        " generics",
        " generic",
        " typing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa6784da25b6d25dba1b08feb7030288aeba09d8fb39483cf1a7bba33e98f940",
                "md5": "2eaa5315cba63c74aadb103c85f8f0ed",
                "sha256": "c0f3b502e08c1a6563c77e915c739cb4a7e50f3f44e498f5ce39b8f003fe837c"
            },
            "downloads": -1,
            "filename": "griffe_generics-1.0.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2eaa5315cba63c74aadb103c85f8f0ed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 10546,
            "upload_time": "2024-07-31T06:10:46",
            "upload_time_iso_8601": "2024-07-31T06:10:46.598856Z",
            "url": "https://files.pythonhosted.org/packages/fa/67/84da25b6d25dba1b08feb7030288aeba09d8fb39483cf1a7bba33e98f940/griffe_generics-1.0.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e7a0a6a4a222ad549dfe55d194aa905b462b7e3de0b7da842dfd01a572967ef",
                "md5": "8b48bc2944569cb1c0369e4535b76f9b",
                "sha256": "2e39489a443f1b58aa9fd1a394168725692e92a5d695c400644e58ff41e7885c"
            },
            "downloads": -1,
            "filename": "griffe_generics-1.0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "8b48bc2944569cb1c0369e4535b76f9b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8040,
            "upload_time": "2024-07-31T06:10:47",
            "upload_time_iso_8601": "2024-07-31T06:10:47.625785Z",
            "url": "https://files.pythonhosted.org/packages/5e/7a/0a6a4a222ad549dfe55d194aa905b462b7e3de0b7da842dfd01a572967ef/griffe_generics-1.0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-31 06:10:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jonghwanhyeon",
    "github_project": "griffe-generics",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "griffe",
            "specs": []
        },
        {
            "name": "typing-extensions",
            "specs": []
        }
    ],
    "lcname": "griffe-generics"
}