Skip to content

WebRTC models as Python dataclasses with mashumaro

License

Notifications You must be signed in to change notification settings

home-assistant-libs/python-webrtc-models

Repository files navigation

Python: WebRTC models

This package provides some data classes for the WebRTC spec

Installation

uv pip install webrtc-models

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Setting up development environment

This Python project is fully managed using the uv dependency manager.

You need at least:

To install all packages, including all development requirements:

uv sync --dev

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following commands:

In the project venv

pre-commit run -a

or with

uv run pre-commit run -a

To run just the Python tests:

uv run pytest

Authors & contributors

The content is by Robert Resch.

For a full list of all authors and contributors, check the contributor's page.