| Name | transmission-rpc JSON |
| Version |
7.0.11
JSON |
| download |
| home_page | None |
| Summary | Python module that implements the Transmission bittorent client JSON-RPC protocol |
| upload_time | 2024-08-20 22:41:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.8 |
| license | None |
| keywords |
transmission
rpc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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)
## Introduction
`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)
Support 2.40 (released 2011-10-05) <= transmission version <= 4.0.6 (released 2024-05-29),
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>=3.10](https://python.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
python -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
# install git pre-commit hooks
pre-commit install
```
### 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": null,
"name": "transmission-rpc",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": "transmission, rpc",
"author": null,
"author_email": "trim21 <trim21me@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/68/b8/dc4debf525c3bb8a676f4fd0ab8534845e3b067c78a81ad05ac39014d849/transmission_rpc-7.0.11.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## Introduction\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\nSupport 2.40 (released 2011-10-05) <= transmission version <= 4.0.6 (released 2024-05-29),\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>=3.10](https://python.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\npython -m venv .venv\nsource .venv/bin/activate\npip install -e '.[dev]'\n# install git pre-commit hooks\npre-commit install\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": null,
"summary": "Python module that implements the Transmission bittorent client JSON-RPC protocol",
"version": "7.0.11",
"project_urls": {
"Homepage": "https://github.com/Trim21/transmission-rpc"
},
"split_keywords": [
"transmission",
" rpc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9f4c6319bcb1026e3f78c9cbcc9c24de77a76f09954e67ffc5ebfc29f7ce4b90",
"md5": "fdf969e774b5d37dba139cd9e5444822",
"sha256": "94fd008b54640dd9fff14d7ae26848f901e9d130a70950b8930f9b395988914f"
},
"downloads": -1,
"filename": "transmission_rpc-7.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdf969e774b5d37dba139cd9e5444822",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "~=3.8",
"size": 28231,
"upload_time": "2024-08-20T22:41:05",
"upload_time_iso_8601": "2024-08-20T22:41:05.777658Z",
"url": "https://files.pythonhosted.org/packages/9f/4c/6319bcb1026e3f78c9cbcc9c24de77a76f09954e67ffc5ebfc29f7ce4b90/transmission_rpc-7.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "68b8dc4debf525c3bb8a676f4fd0ab8534845e3b067c78a81ad05ac39014d849",
"md5": "ee201e2554ed34e5b509e12ee6821031",
"sha256": "5872322e60b42e368bc9c4724773aea4593113cb19bd2da589f0ffcdabe57963"
},
"downloads": -1,
"filename": "transmission_rpc-7.0.11.tar.gz",
"has_sig": false,
"md5_digest": "ee201e2554ed34e5b509e12ee6821031",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 113744,
"upload_time": "2024-08-20T22:41:07",
"upload_time_iso_8601": "2024-08-20T22:41:07.485678Z",
"url": "https://files.pythonhosted.org/packages/68/b8/dc4debf525c3bb8a676f4fd0ab8534845e3b067c78a81ad05ac39014d849/transmission_rpc-7.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 22:41:07",
"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"
}
