https://github.com/kannibalox/pyrosimple

An overhauled fork of the pyrocore tools for rTorrent
https://github.com/kannibalox/pyrosimple

bittorrent command-line python rtorrent rtorrent-ps

Last synced: 4 months ago
JSON representation

An overhauled fork of the pyrocore tools for rTorrent

• Host: GitHub
• URL: https://github.com/kannibalox/pyrosimple
• Owner: kannibalox
• License: gpl-3.0
• Created: 2021-11-01T13:32:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-23T03:29:52.000Z (9 months ago)
• Last Synced: 2025-05-30T21:28:13.908Z (5 months ago)
• Topics: bittorrent, command-line, python, rtorrent, rtorrent-ps
• Language: Python
• Homepage: https://kannibalox.github.io/pyrosimple/
• Size: 5.17 MB
• Stars: 63
• Watchers: 4
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

README

          
# pyrosimple

[![GitHub Workflow Status](http://img.shields.io/github/actions/workflow/status/kannibalox/pyrosimple/pylint.yml?branch=main)](https://github.com/kannibalox/pyrosimple/actions/workflows/pylint.yml)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrosimple)](https://pypi.org/project/pyrosimple/)

[![PyPI](https://img.shields.io/pypi/v/pyrosimple)](https://pypi.org/project/pyrosimple/)

[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/kannibalox/pyrosimple/2?label=docker&link=https%3A%2F%2Fhub.docker.com%2Fr%2Fkannibalox%2Fpyrosimple%2Ftags)](https://hub.docker.com/r/kannibalox/pyrosimple/tags)

A overhauled Python 3 fork of the [pyrocore

tools](https://github.com/pyroscope/pyrocore), for working with the

[rTorrent client](https://github.com/rakshasa/rtorrent).

## Installation

```bash

pip install pyrosimple

# pip install 'pyrosimple[torque]' # Optional dependencies for using pyrotorque

```

See the [documentation for usage](https://kannibalox.github.io/pyrosimple/).

If you've used rtcontrol/rtxmlrpc before, you should feel right at home.

## What's the point of this?

The pyrocore tools are great, but being stuck on python 2, along with

the complicated install procedure made integrating both the tools and

the code into other processes very painful.

## Differences from pyrocore

The following lists are not exhaustive, and don't cover many of the

internal improvements and refactoring.

- Only supports python 3 and rTorrent 0.9.6+ (this includes

  [rTorrent-PS](https://github.com/pyroscope/rtorrent-ps), [rTorrent-PS-CH](https://github.com/chros73/rtorrent-ps-ch/) and [jesec/rtorrent](https://github.com/jesec/rtorrent))

  - pypy is supported, but not as well tested

- Simpler poetry-based build system, with a single package to install

- Performance improvements (faster templating and only fetching

  required fields)

- Replaced Tempita with [Jinja2](https://jinja.palletsprojects.com/en/3.0.x/)

### New features

- Multi-instance support for rtcontrol/rtxmlrpc

- Support for JSON-RPC (currently only implemented by

  [jesec/rtorrent](https://github.com/jesec/rtorrent))

- Actions to move torrents between paths, or torrents between hosts

See https://kannibalox.github.io/pyrosimple/migrate/ for how to

migrate scripts to the new features.

## Legacy branch

If you just want to use the pyrocore tools on python 3 without all the

new features, you can use the `release-1.X` branch (1.3 is the latest

release at time of writing).  These releases will only receive bug

fixes or changes to maintain compatibility with the original pyrocore

tools.