Transmission-rpc Readme

Introduction

transmission-rpc is a python wrapper on top of transmission JSON RPC protocol, hosted on GitHub at 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, report an issue if you found unexpected API break changes at same major version.

Install

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, and task (or you can also run command in taskfile.yaml directly).

It's recommended to python3.10 as local development python version.

python -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
# install git pre-commit hooks
pre-commit install

Lint

task lint

Testing

You need to have a transmission daemon running

then add a .env file

export TR_HOST="..."
export TR_PORT="..."
export TR_USER="..."
export TR_PASS="..."

task test

License

transmission-rpc is licensed under the MIT license.