rtorrent-rpc


Namertorrent-rpc JSON
Version 0.9.4 PyPI version JSON
download
home_pageNone
SummaryTyped rtorrent rpc client
upload_time2024-10-12 17:16:47
maintainerNone
docs_urlNone
authorNone
requires_python~=3.8
licenseNone
keywords rtorrent rpc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Typed rtorrent rpc client

[![PyPI](https://img.shields.io/pypi/v/rtorrent-rpc)](https://pypi.org/project/rtorrent-rpc/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rtorrent-rpc)](https://pypi.org/project/rtorrent-rpc/)
[![Documentation Status](https://readthedocs.org/projects/rtorrent-rpc/badge/)](https://rtorrent-rpc.readthedocs.io/)

`rtorrent-rpc` is a python wrapper on top of rtorrent XML RPC protocol,
hosted on GitHub
at [github.com/trim21/rtorrent-rpc](https://github.com/trim21/rtorrent-rpc)

Document is hosted at https://rtorrent-rpc.readthedocs.io/ by readthedocs.

## Introduction

```console
pip install rtorrent-rpc
```

supported extras:

- `orjson`: use [orjson](https://github.com/ijl/orjson) as jsonlib

```console
pip install 'rtorrent-rpc[orjson]'
```

## Contributing

All kinds of PRs (docs, feature, bug fixes and eta...) are most welcome.

## Quick Start

```python
from rtorrent_rpc import RTorrent

client = RTorrent(address='scgi://127.0.0.1:5000')
unix_client = RTorrent(address='scgi:///home/ubuntu/.local/share/rtorrent.sock')
```

tls cert validation is enabled when you are using `https` protocol, set environment
variable `PY_RTORRENT_RPC_DISABLE_TLS_CERT=1` to disable.

## Known Problem

rTorrent's [xmlrpc do not support all utf8 characters](https://github.com/rakshasa/rtorrent/issues/1250),
for example, emoji.

If torrent name of file name contains any emoji,
you can't retrieve correct torrent name or file name through xmlrpc.

Please consider use a rtorrent distro with json-rpc support,
for example: [jesec/rtorrent](https://github.com/jesec/rtorrent), which support utf8
correctly.

If your rtorrent distro support jsonrpc,
you can use send json-rpc request with `RTorrent(...).jsonrpc.call(...)`.

## License

`rtorrent-rpc` is licensed under the MIT license.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rtorrent-rpc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": "rtorrent, rpc",
    "author": null,
    "author_email": "trim21 <trim21me@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/07/b50c48e33b985c087981d0e85f29a97cc7f0af86dc53c4330297054bd5ac/rtorrent_rpc-0.9.4.tar.gz",
    "platform": null,
    "description": "# Typed rtorrent rpc client\n\n[![PyPI](https://img.shields.io/pypi/v/rtorrent-rpc)](https://pypi.org/project/rtorrent-rpc/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rtorrent-rpc)](https://pypi.org/project/rtorrent-rpc/)\n[![Documentation Status](https://readthedocs.org/projects/rtorrent-rpc/badge/)](https://rtorrent-rpc.readthedocs.io/)\n\n`rtorrent-rpc` is a python wrapper on top of rtorrent XML RPC protocol,\nhosted on GitHub\nat [github.com/trim21/rtorrent-rpc](https://github.com/trim21/rtorrent-rpc)\n\nDocument is hosted at https://rtorrent-rpc.readthedocs.io/ by readthedocs.\n\n## Introduction\n\n```console\npip install rtorrent-rpc\n```\n\nsupported extras:\n\n- `orjson`: use [orjson](https://github.com/ijl/orjson) as jsonlib\n\n```console\npip install 'rtorrent-rpc[orjson]'\n```\n\n## Contributing\n\nAll kinds of PRs (docs, feature, bug fixes and eta...) are most welcome.\n\n## Quick Start\n\n```python\nfrom rtorrent_rpc import RTorrent\n\nclient = RTorrent(address='scgi://127.0.0.1:5000')\nunix_client = RTorrent(address='scgi:///home/ubuntu/.local/share/rtorrent.sock')\n```\n\ntls cert validation is enabled when you are using `https` protocol, set environment\nvariable `PY_RTORRENT_RPC_DISABLE_TLS_CERT=1` to disable.\n\n## Known Problem\n\nrTorrent's [xmlrpc do not support all utf8 characters](https://github.com/rakshasa/rtorrent/issues/1250),\nfor example, emoji.\n\nIf torrent name of file name contains any emoji,\nyou can't retrieve correct torrent name or file name through xmlrpc.\n\nPlease consider use a rtorrent distro with json-rpc support,\nfor example: [jesec/rtorrent](https://github.com/jesec/rtorrent), which support utf8\ncorrectly.\n\nIf your rtorrent distro support jsonrpc,\nyou can use send json-rpc request with `RTorrent(...).jsonrpc.call(...)`.\n\n## License\n\n`rtorrent-rpc` is licensed under the MIT license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Typed rtorrent rpc client",
    "version": "0.9.4",
    "project_urls": {
        "Homepage": "https://github.com/trim21/rtorrent-rpc"
    },
    "split_keywords": [
        "rtorrent",
        " rpc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "babcbc2fc9a30ee95fde6c7bfb3533f7cae0aba506ca4136cd3978614ca547d2",
                "md5": "235569f6bb6d58a7d804984735924afd",
                "sha256": "db8eca182fc9f131cc82cb00ec517d50ccec1aa193b395a709e6c4da2969f94f"
            },
            "downloads": -1,
            "filename": "rtorrent_rpc-0.9.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "235569f6bb6d58a7d804984735924afd",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": "~=3.8",
            "size": 15563,
            "upload_time": "2024-10-12T17:16:45",
            "upload_time_iso_8601": "2024-10-12T17:16:45.937570Z",
            "url": "https://files.pythonhosted.org/packages/ba/bc/bc2fc9a30ee95fde6c7bfb3533f7cae0aba506ca4136cd3978614ca547d2/rtorrent_rpc-0.9.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff07b50c48e33b985c087981d0e85f29a97cc7f0af86dc53c4330297054bd5ac",
                "md5": "2c2ed460a92660e9d38c5f203ed476ef",
                "sha256": "04bd85c30549ec6d888956741a7035009053d8d3766d99a4ffa35a4a11bdb715"
            },
            "downloads": -1,
            "filename": "rtorrent_rpc-0.9.4.tar.gz",
            "has_sig": false,
            "md5_digest": "2c2ed460a92660e9d38c5f203ed476ef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 398629,
            "upload_time": "2024-10-12T17:16:47",
            "upload_time_iso_8601": "2024-10-12T17:16:47.060147Z",
            "url": "https://files.pythonhosted.org/packages/ff/07/b50c48e33b985c087981d0e85f29a97cc7f0af86dc53c4330297054bd5ac/rtorrent_rpc-0.9.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-12 17:16:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "trim21",
    "github_project": "rtorrent-rpc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "rtorrent-rpc"
}
None
Elapsed time: 0.31732s