pydantic-asyncapi


Namepydantic-asyncapi JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryPydantic models of AsyncAPI schema
upload_time2024-07-26 11:32:55
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords asyncapi pydantic schema
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ![Tests](https://github.com/asynq-io/pydantic-asyncapi/workflows/Tests/badge.svg)
![Build](https://github.com/asynq-io/pydantic-asyncapi/workflows/Publish/badge.svg)
![License](https://img.shields.io/github/license/asynq-io/pydantic-asyncapi)
![Mypy](https://img.shields.io/badge/mypy-checked-blue)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://docs.pydantic.dev/latest/contributing/#badges)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
![Python](https://img.shields.io/pypi/pyversions/pydantic-asyncapi)
![Format](https://img.shields.io/pypi/format/pydantic-asyncapi)
![PyPi](https://img.shields.io/pypi/v/pydantic-asyncapi)

# Pydantic AsyncAPI

Pydantic models for AsyncAPI

## Installation

```shell
pip install pydantic-asyncapi
```

## About

This package provides Pydantic models for [AsyncAPI](https://www.asyncapi.com/).
Currently versions `2.6.0` and `3.0.0` are supported.

The package can be used to:

1. Validate AsyncAPI documents
2. Generate AsyncAPI documents from code
3. Create Python frameworks/applications based on AsyncAPI specification

## Usage

```python
from pydantic_asyncapi import AsyncAPI

# v2 or v3 based on on 'asyncapi' version field
model = AsyncAPI.model_validate(...)

```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pydantic-asyncapi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "asyncapi, pydantic, schema",
    "author": null,
    "author_email": "RaRhAeu <rarha_eu@protonmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/2b/86/699fb6125a321c536f3a17d4623bd0e743fb41fe240ca842cacb9e898a2c/pydantic_asyncapi-0.2.1.tar.gz",
    "platform": null,
    "description": "![Tests](https://github.com/asynq-io/pydantic-asyncapi/workflows/Tests/badge.svg)\n![Build](https://github.com/asynq-io/pydantic-asyncapi/workflows/Publish/badge.svg)\n![License](https://img.shields.io/github/license/asynq-io/pydantic-asyncapi)\n![Mypy](https://img.shields.io/badge/mypy-checked-blue)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://docs.pydantic.dev/latest/contributing/#badges)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n![Python](https://img.shields.io/pypi/pyversions/pydantic-asyncapi)\n![Format](https://img.shields.io/pypi/format/pydantic-asyncapi)\n![PyPi](https://img.shields.io/pypi/v/pydantic-asyncapi)\n\n# Pydantic AsyncAPI\n\nPydantic models for AsyncAPI\n\n## Installation\n\n```shell\npip install pydantic-asyncapi\n```\n\n## About\n\nThis package provides Pydantic models for [AsyncAPI](https://www.asyncapi.com/).\nCurrently versions `2.6.0` and `3.0.0` are supported.\n\nThe package can be used to:\n\n1. Validate AsyncAPI documents\n2. Generate AsyncAPI documents from code\n3. Create Python frameworks/applications based on AsyncAPI specification\n\n## Usage\n\n```python\nfrom pydantic_asyncapi import AsyncAPI\n\n# v2 or v3 based on on 'asyncapi' version field\nmodel = AsyncAPI.model_validate(...)\n\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Pydantic models of AsyncAPI schema",
    "version": "0.2.1",
    "project_urls": {
        "Documentation": "https://github.com/asynq-io/pydantic-asyncapi#readme",
        "Issues": "https://github.com/asynq-io/pydantic-asyncapi/issues",
        "Source": "https://github.com/asynq-io/pydantic-asyncapi"
    },
    "split_keywords": [
        "asyncapi",
        " pydantic",
        " schema"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "20a59648ef0235d78ca1220e8c8bddc9067092664336bc4bc4105d94d63667d6",
                "md5": "35eff4a99d3d58a2a7754f3ca75422ea",
                "sha256": "eefb5e37f27556cc42809b58481d6e3416cca3c2219b4155a1a67c4da747e137"
            },
            "downloads": -1,
            "filename": "pydantic_asyncapi-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "35eff4a99d3d58a2a7754f3ca75422ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10783,
            "upload_time": "2024-07-26T11:32:53",
            "upload_time_iso_8601": "2024-07-26T11:32:53.966375Z",
            "url": "https://files.pythonhosted.org/packages/20/a5/9648ef0235d78ca1220e8c8bddc9067092664336bc4bc4105d94d63667d6/pydantic_asyncapi-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2b86699fb6125a321c536f3a17d4623bd0e743fb41fe240ca842cacb9e898a2c",
                "md5": "4b0e79cdbcad2b1cc11694d1b625aaa3",
                "sha256": "d9894c09b5d5ad308d42da01c5f75f6dd0425d47744cd58e6abadc999b5edbe2"
            },
            "downloads": -1,
            "filename": "pydantic_asyncapi-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4b0e79cdbcad2b1cc11694d1b625aaa3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 11333,
            "upload_time": "2024-07-26T11:32:55",
            "upload_time_iso_8601": "2024-07-26T11:32:55.185087Z",
            "url": "https://files.pythonhosted.org/packages/2b/86/699fb6125a321c536f3a17d4623bd0e743fb41fe240ca842cacb9e898a2c/pydantic_asyncapi-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 11:32:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "asynq-io",
    "github_project": "pydantic-asyncapi#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pydantic-asyncapi"
}
None
Elapsed time: 2.70772s