# Transmission-rpc Readme
[](https://pypi.org/project/transmission-rpc/)
[](https://transmission-rpc.readthedocs.io/)
[](https://github.com/Trim21/transmission-rpc/actions)
[](https://pypi.org/project/transmission-rpc/)
[](https://codecov.io/gh/Trim21/transmission-rpc/branch/master)
`transmission-rpc` is a python wrapper on top of [transmission](https://github.com/transmission/transmission) JSON RPC protocol,
hosted on GitHub at [github.com/trim21/transmission-rpc](https://github.com/trim21/transmission-rpc)
## Introduction
`transmission-rpc` is a python module implementing the json-rpc client protocol for the BitTorrent client Transmission.
Support 14 <= rpc version <= 17 (2.40 <= transmission version <= 4.0.4),
should works fine with newer rpc version but some new feature may be missing.
## versioning
`transmission-rpc` follow [Semantic Versioning](https://semver.org/),
report an issue if you found unexpected API break changes at same major version.
## Install
```console
pip install transmission-rpc -U
```
## Documents
<https://transmission-rpc.readthedocs.io/en/stable/>
## Contributing
All kinds of PRs (docs, feature, bug fixes and eta...) are most welcome.
### Setup Local Development Environment
At first, you need to install [python](https://python.org/), [poetry](https://python-poetry.org/) and [task](https://taskfile.dev/) (or you can also run command in `taskfile.yaml` directly).
It's recommended to python3.10 as local development python version.
```shell
poetry install --sync
poetry run pre-commit install # install git pre-commit hooks
```
### Lint
```shell
task lint
```
### Testing
You need to have a transmission daemon running
then add a `.env` file
```shell
export TR_HOST="..."
export TR_PORT="..."
export TR_USER="..."
export TR_PASS="..."
```
```shell
task test
```
## License
`transmission-rpc` is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/Trim21/transmission-rpc",
"name": "transmission-rpc",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "transmission, rpc",
"author": "Trim21",
"author_email": "i@trim21.me",
"download_url": "https://files.pythonhosted.org/packages/1f/46/8fe964511f748765a48292e842b9f826815d86f80dc2e1c4940394f1465a/transmission_rpc-7.0.5.tar.gz",
"platform": null,
"description": "# Transmission-rpc Readme\n\n[](https://pypi.org/project/transmission-rpc/)\n[](https://transmission-rpc.readthedocs.io/)\n[](https://github.com/Trim21/transmission-rpc/actions)\n[](https://pypi.org/project/transmission-rpc/)\n[](https://codecov.io/gh/Trim21/transmission-rpc/branch/master)\n\n`transmission-rpc` is a python wrapper on top of [transmission](https://github.com/transmission/transmission) JSON RPC protocol,\nhosted on GitHub at [github.com/trim21/transmission-rpc](https://github.com/trim21/transmission-rpc)\n\n## Introduction\n\n`transmission-rpc` is a python module implementing the json-rpc client protocol for the BitTorrent client Transmission.\n\nSupport 14 <= rpc version <= 17 (2.40 <= transmission version <= 4.0.4),\nshould works fine with newer rpc version but some new feature may be missing.\n\n## versioning\n\n`transmission-rpc` follow [Semantic Versioning](https://semver.org/),\nreport an issue if you found unexpected API break changes at same major version.\n\n## Install\n\n```console\npip install transmission-rpc -U\n```\n\n## Documents\n\n<https://transmission-rpc.readthedocs.io/en/stable/>\n\n## Contributing\n\nAll kinds of PRs (docs, feature, bug fixes and eta...) are most welcome.\n\n### Setup Local Development Environment\n\nAt first, you need to install [python](https://python.org/), [poetry](https://python-poetry.org/) and [task](https://taskfile.dev/) (or you can also run command in `taskfile.yaml` directly).\n\nIt's recommended to python3.10 as local development python version.\n\n```shell\npoetry install --sync\npoetry run pre-commit install # install git pre-commit hooks\n```\n\n### Lint\n\n```shell\ntask lint\n```\n\n### Testing\n\nYou need to have a transmission daemon running\n\nthen add a `.env` file\n\n```shell\nexport TR_HOST=\"...\"\nexport TR_PORT=\"...\"\nexport TR_USER=\"...\"\nexport TR_PASS=\"...\"\n```\n\n```shell\ntask test\n```\n\n## License\n\n`transmission-rpc` is licensed under the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python module that implements the Transmission bittorent client JSON-RPC protocol",
"version": "7.0.5",
"project_urls": {
"Homepage": "https://github.com/Trim21/transmission-rpc",
"Repository": "https://github.com/Trim21/transmission-rpc"
},
"split_keywords": [
"transmission",
" rpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a965e40b30c12d3bda2bef07d5f904158c07fc66b877fa304a381089bf27a011",
"md5": "215061acf0509f0cb32d4b045e050c5f",
"sha256": "bb9f9400d99362e41b33cf787aaf74f52a03c8fa901c31276007e256d23c3ec6"
},
"downloads": -1,
"filename": "transmission_rpc-7.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "215061acf0509f0cb32d4b045e050c5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 27385,
"upload_time": "2024-05-07T03:57:04",
"upload_time_iso_8601": "2024-05-07T03:57:04.577774Z",
"url": "https://files.pythonhosted.org/packages/a9/65/e40b30c12d3bda2bef07d5f904158c07fc66b877fa304a381089bf27a011/transmission_rpc-7.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f468fe964511f748765a48292e842b9f826815d86f80dc2e1c4940394f1465a",
"md5": "8df06fe22f632e2ffff1b99a6c0f10f4",
"sha256": "f1a0a834309cc3d94ea05b7c841706606f92cdadc0c5a684b1e725a336c35566"
},
"downloads": -1,
"filename": "transmission_rpc-7.0.5.tar.gz",
"has_sig": false,
"md5_digest": "8df06fe22f632e2ffff1b99a6c0f10f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 25493,
"upload_time": "2024-05-07T03:57:05",
"upload_time_iso_8601": "2024-05-07T03:57:05.922916Z",
"url": "https://files.pythonhosted.org/packages/1f/46/8fe964511f748765a48292e842b9f826815d86f80dc2e1c4940394f1465a/transmission_rpc-7.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 03:57:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Trim21",
"github_project": "transmission-rpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "transmission-rpc"
}
JSON
