| Name | webrtc-models JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Python WebRTC models |
| upload_time | 2024-11-18 17:43:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12.0 |
| license | Apache-2.0 |
| keywords |
webrtc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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/
Raw data
{
"_id": null,
"home_page": null,
"name": "webrtc-models",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.0",
"maintainer_email": null,
"keywords": "webrtc",
"author": null,
"author_email": "Robert Resch <robert@resch.dev>",
"download_url": "https://files.pythonhosted.org/packages/80/e8/050ffe3b71ff44d3885eee2bed763ca937e2a30bc950d866f22ba657776b/webrtc_models-0.3.0.tar.gz",
"platform": null,
"description": "# Python: WebRTC models\n\nThis package provides some data classes for the [WebRTC spec][webrtc-spec]\n\n## Installation\n\n```bash\nuv pip install webrtc-models\n```\n\n## Changelog & Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented\nbased on the following:\n\n- `MAJOR`: Incompatible or major changes.\n- `MINOR`: Backwards-compatible new features and enhancements.\n- `PATCH`: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](.github/CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThis Python project is fully managed using the [uv][uv] dependency manager.\n\nYou need at least:\n\n- [uv][uv-install]\n\nTo install all packages, including all development requirements:\n\n```bash\nuv sync --dev\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following commands:\n\nIn the project venv\n\n```bash\npre-commit run -a\n```\n\nor with\n\n```bash\nuv run pre-commit run -a\n```\n\nTo run just the Python tests:\n\n```bash\nuv run pytest\n```\n\n## Authors & contributors\n\nThe content is by [Robert Resch][edenhaus].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n[contributors]: https://github.com/home-assistant-libs/python-webrtc-models/graphs/contributors\n[edenhaus]: https://github.com/edenhaus\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[uv]: https://docs.astral.sh/uv/\n[uv-install]: https://docs.astral.sh/uv/getting-started/installation/\n[pre-commit]: https://pre-commit.com/\n[releases]: https://github.com/home-assistant-libs/python-webrtc-models/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n[webrtc-spec]: https://www.w3.org/TR/webrtc/\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python WebRTC models",
"version": "0.3.0",
"project_urls": {
"Bug Reports": "https://github.com/home-assistant-libs/python-webrtc-models/issues",
"Homepage": "https://pypi.org/project/webrtc-models",
"Source Code": "https://github.com/home-assistant-libs/python-webrtc-models"
},
"split_keywords": [
"webrtc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f2e762f29980c9e8d75af93b642a0c37aa8e201fd5268ba3a7179c172549bac3",
"md5": "330d7488ca8eeb5db97b0db3ef49a255",
"sha256": "8fddded3ffd7ca837de878033501927580799a2c1b7829f7ae8a0f43b49004ea"
},
"downloads": -1,
"filename": "webrtc_models-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "330d7488ca8eeb5db97b0db3ef49a255",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.0",
"size": 7476,
"upload_time": "2024-11-18T17:43:44",
"upload_time_iso_8601": "2024-11-18T17:43:44.165664Z",
"url": "https://files.pythonhosted.org/packages/f2/e7/62f29980c9e8d75af93b642a0c37aa8e201fd5268ba3a7179c172549bac3/webrtc_models-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "80e8050ffe3b71ff44d3885eee2bed763ca937e2a30bc950d866f22ba657776b",
"md5": "289e56a03d05c0c0dd4a37153fdb2a3c",
"sha256": "559c743e5cc3bcc8133be1b6fb5e8492a9ddb17151129c21cbb2e3f2a1166526"
},
"downloads": -1,
"filename": "webrtc_models-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "289e56a03d05c0c0dd4a37153fdb2a3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.0",
"size": 9411,
"upload_time": "2024-11-18T17:43:45",
"upload_time_iso_8601": "2024-11-18T17:43:45.682285Z",
"url": "https://files.pythonhosted.org/packages/80/e8/050ffe3b71ff44d3885eee2bed763ca937e2a30bc950d866f22ba657776b/webrtc_models-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 17:43:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "home-assistant-libs",
"github_project": "python-webrtc-models",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "webrtc-models"
}
