|
1 | 1 | # -*- coding: utf-8 -*- |
2 | 2 | """ PyroCore - Python Torrent Tools Core Package. |
3 | 3 |
|
4 | | - PyroScope is a collection of tools for the BitTorrent protocol and especially the rTorrent client. |
5 | | -
|
6 | | - This is the core package and basic command line tools subproject. |
| 4 | + This project provides a collection of tools for the BitTorrent protocol |
| 5 | + and especially the `rTorrent client`_. They enable you to filter |
| 6 | + rTorrent's item list for displaying or changing selected items, also |
| 7 | + creating, inspecting and changing ``.torrent`` files, and much more. |
| 8 | +
|
| 9 | + An optional daemon process (``pyrotorque``) can add flexible queue |
| 10 | + management for rTorrent, starting items added in bulk slowly over time |
| 11 | + according to customizable rules. The same daemon can also watch one or |
| 12 | + more directory trees recursively for new metafiles using inotify, |
| 13 | + resulting in instantaneous loading without any polling and no extra |
| 14 | + configuration for nested directories. |
| 15 | +
|
| 16 | + The ``PyroScope`` command line utilities are *not* the same as the |
| 17 | + sibling project `rTorrent-PS`_, and they work perfectly fine without it; |
| 18 | + the same is true the other way 'round. It's just that both |
| 19 | + unsurprisingly have synergies if used together, and some features *do* |
| 20 | + only work when both are present. |
| 21 | +
|
| 22 | + Further information can be found in the `main documentation`_. |
| 23 | +
|
| 24 | + To get in contact and share your experiences with other users of *PyroScope*, |
| 25 | + join the `pyroscope-users`_ mailing list or the inofficial ``##rtorrent`` |
| 26 | + channel on ``irc.freenode.net``. |
| 27 | +
|
| 28 | + .. _rTorrent client: https://github.com/rakshasa/rtorrent |
| 29 | + .. _rTorrent-PS: https://github.com/pyroscope/rtorrent-ps |
| 30 | + .. _main documentation: http://pyrocore.readthedocs.io/ |
| 31 | + .. _pyroscope-users: http://groups.google.com/group/pyroscope-users |
7 | 32 |
|
8 | 33 | Copyright (c) 2009 - 2017 The PyroScope Project <[email protected]> |
9 | 34 |
|
|
0 commit comments