1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# Python: WebRTC models
This package provides some data classes for the [WebRTC spec][webrtc-spec]
## Installation
```bash
uv pip install webrtc-models
```
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]
functionality. The format of the log is based on
[Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], 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](.github/CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
This Python project is fully managed using the [uv][uv] dependency manager.
You need at least:
- [uv][uv-install]
To install all packages, including all development requirements:
```bash
uv sync --dev
```
As this repository uses the [pre-commit][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
```bash
pre-commit run -a
```
or with
```bash
uv run pre-commit run -a
```
To run just the Python tests:
```bash
uv run pytest
```
## Authors & contributors
The content is by [Robert Resch][edenhaus].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
[contributors]: https://github.com/home-assistant-libs/python-webrtc-models/graphs/contributors
[edenhaus]: https://github.com/edenhaus
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[uv]: https://docs.astral.sh/uv/
[uv-install]: https://docs.astral.sh/uv/getting-started/installation/
[pre-commit]: https://pre-commit.com/
[releases]: https://github.com/home-assistant-libs/python-webrtc-models/releases
[semver]: http://semver.org/spec/v2.0.0.html
[webrtc-spec]: https://www.w3.org/TR/webrtc/
|
