https://github.com/asynq-io/pydantic-asyncapi

Pydantic models for AsyncAPI schema
https://github.com/asynq-io/pydantic-asyncapi

asyncapi pydantic python

Last synced: 9 days ago
JSON representation

Pydantic models for AsyncAPI schema

• Host: GitHub
• URL: https://github.com/asynq-io/pydantic-asyncapi
• Owner: asynq-io
• License: apache-2.0
• Created: 2024-07-15T11:02:35.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-04-22T18:12:00.000Z (9 days ago)
• Last Synced: 2025-04-22T19:29:00.799Z (9 days ago)
• Topics: asyncapi, pydantic, python
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 4
• Watchers: 0
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![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(...)

```