Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/borzunov/bit-torrent
📁 🌎 BitTorrent client built with Python + asyncio
https://github.com/borzunov/bit-torrent
asyncio bittorrent python qt torrent
Last synced: about 3 hours ago
JSON representation
📁 🌎 BitTorrent client built with Python + asyncio
- Host: GitHub
- URL: https://github.com/borzunov/bit-torrent
- Owner: borzunov
- License: mit
- Created: 2016-03-07T13:20:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T15:09:07.000Z (about 1 year ago)
- Last Synced: 2024-08-07T18:43:25.745Z (about 2 months ago)
- Topics: asyncio, bittorrent, python, qt, torrent
- Language: Python
- Homepage:
- Size: 488 KB
- Stars: 155
- Watchers: 9
- Forks: 27
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
bit-torrent
===========
Simple BitTorrent client built with Python's asyncio
Features
--------
* Downloading torrents and sharing received data
* Graphical interface (supports Drag'n'Drop and can be assigned to *.torrent files in system "Open with..." dialog)
* Console interface
* Pausing torrents, watching progress, download and upload speed, ETA
* Selecting which files in a torrent you want to download
* Saving state between program restarts
Implemented specifications:
* The BitTorrent Protocol Specification ([BEP 0003][] with some additions from [the community spec][])
* Multitracker Metadata Extension ([BEP 0012][])
* *(partially)* UDP Tracker Protocol ([BEP 0015][])
* Tracker Returns Compact Peer Lists ([BEP 0023][])
[BEP 0003]: http://www.bittorrent.org/beps/bep_0003.html
[the community spec]: https://wiki.theory.org/BitTorrentSpecification
[BEP 0012]: http://www.bittorrent.org/beps/bep_0012.html
[BEP 0015]: http://www.bittorrent.org/beps/bep_0015.html
[BEP 0023]: http://www.bittorrent.org/beps/bep_0023.html
Architecture
------------
In this project, I tried to avoid threads and use only asynchronous I/O. As a result, all algorithms and network interaction work in one thread running an asyncio event loop, but there are still a few additional threads:
* Non-blocking disk I/O [isn't supported][asyncio-fs] by asyncio. To prevent freezes for up to a second
during disk writing, blocking I/O runs in a [ThreadPoolExecutor][].
* PyQt GUI runs in the main thread and invokes an asyncio event loop in a separate [QThread][]. Another option is
to use a Qt event loop in asyncio with [quamash][], but this increases UI reaction time, and the Qt event loop
may be less efficient than asyncio's default one.
[asyncio-fs]: https://github.com/python/asyncio/wiki/ThirdParty#filesystem
[ThreadPoolExecutor]: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ThreadPoolExecutor
[QThread]: https://doc.qt.io/qt-5/qthread.html
[quamash]: https://github.com/harvimt/quamash
Program sources depend on Python 3.5+ features: they are annotated with type hints ([PEP 0484][]) and
use coroutines with `async`/`await` syntax ([PEP 0492][]).
[PEP 0484]: https://www.python.org/dev/peps/pep-0484/
[PEP 0492]: https://www.python.org/dev/peps/pep-0492/
Installation
------------
The program requires Python 3.5+ and works on Linux, macOS, and Windows. You also need PyQt 5 to run GUI.
On Ubuntu 16.04 or newer, run:
```bash
sudo apt-get install python3-pip python3-pyqt5
git clone https://github.com/borzunov/bit-torrent.git && cd bit-torrent
sudo python3 -m pip install -r requirements.txt
```
On macOS, run:
```bash
python3 -m pip install PyQt5
git clone https://github.com/borzunov/bit-torrent.git && cd bit-torrent
python3 -m pip install -r requirements.txt
```
Usage
-----
### Graphical interface
Run:
python3 torrent_gui.py
If torrent files are provided as command line arguments, corresponding adding dialogs will be opened.
### Console interface
1. Start a daemon:
./torrent_cli.py start &
2. *(optional)* Look at a list of files in a torrent you want to download:
./torrent_cli.py show ./examples/debian-11.2.0-amd64-netinst.iso.torrent
3. Specify a download directory and add the torrent to the daemon:
./torrent_cli.py add ./examples/debian-11.2.0-amd64-netinst.iso.torrent -d ./downloads
If the torrent contains more than one file, you can select which files you want to download
using `--include` and `--exclude` options. For more information run:
./torrent_cli.py add --help
4. Watch torrent status:
watch ./torrent_cli.py status
Add `-v` to increase output verbosity.
You also can add more torrents, pause, resume, and remove them. For more information run:
./torrent_cli.py --help
5. To stop the daemon run:
./torrent_cli.py stop
The daemon will restore its state after restart.
### Debug mode
You can enable a verbose debug mode for GUI and CLI daemons by adding `--debug` flag after the script name.
You may also want to enable asyncio debug mode. This is done as follows:
PYTHONASYNCIODEBUG=1 python3 -Wdefault torrent_gui.py --debug
Author
------
Copyright © 2016-2017 Alexander Borzunov