https://github.com/trim21/transmission-rpc
https://github.com/trim21/transmission-rpc
python python3 rpc transmission transmission-rpc
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/trim21/transmission-rpc
- Owner: trim21
- License: mit
- Created: 2018-04-12T08:54:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T14:03:31.000Z (about 1 month ago)
- Last Synced: 2025-04-12T01:54:27.829Z (about 1 month ago)
- Topics: python, python3, rpc, transmission, transmission-rpc
- Language: Python
- Homepage: https://transmission-rpc.readthedocs.io/en/stable/
- Size: 2.04 MB
- Stars: 154
- Watchers: 5
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transmission-rpc Readme
[](https://pypi.org/project/transmission-rpc/)
[](https://transmission-rpc.readthedocs.io/)
[](https://github.com/trim21/transmission-rpc/actions/workflows/ci.yaml)
[](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.1.0-beta.2 (released 2025-05-12),
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.
Due to the tradition of python packaging community,
dropping support for EOL python versions will not be considered breaking change.
## Install
```console
pip install transmission-rpc -U
```
## Documents
## 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.