| Name | go2rtc-client JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Python client for go2rtc |
| upload_time | 2024-12-06 21:06:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12.0 |
| license | Apache-2.0 |
| keywords |
go2rtc
stream
webrtc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python: Go2rtc client
Asynchronous Python client for [go2rtc][go2rtc].
## About
This package allows you to communicate with a [go2rtc][go2rtc] server.
## Installation
```bash
uv pip install go2rtc-client
```
## 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].
[go2rtc]: https://github.com/AlexxIT/go2rtc/
[contributors]: https://github.com/home-assistant-libs/python-go2rtc-client/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-go2rtc-client/releases
[semver]: http://semver.org/spec/v2.0.0.html
Raw data
{
"_id": null,
"home_page": null,
"name": "go2rtc-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.0",
"maintainer_email": null,
"keywords": "go2rtc, stream, webrtc",
"author": null,
"author_email": "Robert Resch <robert@resch.dev>",
"download_url": "https://files.pythonhosted.org/packages/54/ce/cee472c3ab0b43368668a84f60387b294eaf84b9c2890b65019dd2b9641c/go2rtc_client-0.1.2.tar.gz",
"platform": null,
"description": "# Python: Go2rtc client\n\nAsynchronous Python client for [go2rtc][go2rtc].\n\n## About\n\nThis package allows you to communicate with a [go2rtc][go2rtc] server.\n\n## Installation\n\n```bash\nuv pip install go2rtc-client\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[go2rtc]: https://github.com/AlexxIT/go2rtc/\n[contributors]: https://github.com/home-assistant-libs/python-go2rtc-client/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-go2rtc-client/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python client for go2rtc",
"version": "0.1.2",
"project_urls": {
"Bug Reports": "https://github.com/home-assistant-libs/python-go2rtc-client/issues",
"Homepage": "https://pypi.org/project/go2rtc-client",
"Source Code": "https://github.com/home-assistant-libs/python-go2rtc-client"
},
"split_keywords": [
"go2rtc",
" stream",
" webrtc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eefdc47dce8bbe3b782e7f8149dd4ed7428bc7de03510e33d10ff63b5df04c44",
"md5": "ace079835258d7e7e323c7f51f337750",
"sha256": "1f1354e3f2c35f606990b1a8895c5050852d84a435a78e8db80eb1242231c002"
},
"downloads": -1,
"filename": "go2rtc_client-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ace079835258d7e7e323c7f51f337750",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.0",
"size": 13097,
"upload_time": "2024-12-06T21:06:30",
"upload_time_iso_8601": "2024-12-06T21:06:30.984081Z",
"url": "https://files.pythonhosted.org/packages/ee/fd/c47dce8bbe3b782e7f8149dd4ed7428bc7de03510e33d10ff63b5df04c44/go2rtc_client-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "54cecee472c3ab0b43368668a84f60387b294eaf84b9c2890b65019dd2b9641c",
"md5": "784eaabe8b8705e3baa6ce5730739d45",
"sha256": "07cb27bb0252749effe43dbb791caea8ec12df97fee6cff5501544fe163e52cd"
},
"downloads": -1,
"filename": "go2rtc_client-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "784eaabe8b8705e3baa6ce5730739d45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.0",
"size": 13052,
"upload_time": "2024-12-06T21:06:32",
"upload_time_iso_8601": "2024-12-06T21:06:32.554729Z",
"url": "https://files.pythonhosted.org/packages/54/ce/cee472c3ab0b43368668a84f60387b294eaf84b9c2890b65019dd2b9641c/go2rtc_client-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 21:06:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "home-assistant-libs",
"github_project": "python-go2rtc-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "go2rtc-client"
}
