asyncapi-python

AsyncAPI Python Code Generator

[!IMPORTANT] Although commits to dev branch might seem infrequent, the project is under active development as of December 2024.

We currently produce only those changes that are required to satisfy our personal use cases.

The number of commits will grow as we see increase in popularity of it, so do not hesitate to star this repo, open issues, and pull requests.

Link to this github repository

Easily generate type-safe and async Python applications from AsyncAPI 3 specifications.

Features

• Creates Application class from AsyncAPI 3 specifications, implementing every operation in the file
• Generates typed Python code (messages are generated using datamodel-code-generator)
• Performs dynamic validation of messages with Pydantic 2
• Enforces the user code to implement all consumer methods as described by spec
• Provides async code
• Spec parser references other files through absolute or relative paths
• Spec parser references other files through url
• Supports request-reply pattern
• Supports publish-subscribe pattern
• AsyncAPI trait support
• Customizable message encoder/decoder

Requirements

• python>=3.10
• pydantic>=2
• pytz
• For codegen extra
  • jinja2
  • typer
  • datamodel-code-generator
  • pyyaml
• For amqp extra
  • aio-pika

Installation

For code generation (development env), run:

pip install asyncapi-python[codegen]

For runtime, run:

pip install asyncapi-python[amqp]

You can replace amqp with any other supported protocols. For more info, see Supported Protocols section.

Supported Protocols / Use Cases

Below, you may see the table of protocols and the supported use cases. The tick signs (✅) contain links to the examples for each implemented protocol-use case pair, while the hammer signs (🔨) contain links to the Issues tracking the progress for protocol-use case pairs. The list of protocols and use cases is expected to increase over the progress of development.

Use Case	AMQP
Pub-Sub	✅ amqp-pub-sub
Work Queue	✅ amqp-work-queue
RPC	✅ amqp-rpc

Documentation

Although there's no documentation available at the moment, a set of comprehensive examples with comments for each implemented use-case is under the examples directory.

Contributing

Contributions are welcome! Please feel free to open an Issue or submit a Pull Request.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.