https://github.com/gallexis/pytorrent

Simple BitTorrent client made in Python - Use for learning
https://github.com/gallexis/pytorrent

bittorrent bittorrent-client bittorrent-network p2p peer-2-peer peer-to-peer python python-3 torrent

Last synced: about 7 hours ago
JSON representation

Simple BitTorrent client made in Python - Use for learning

• Host: GitHub
• URL: https://github.com/gallexis/pytorrent
• Owner: gallexis
• License: unlicense
• Created: 2015-05-28T10:58:33.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-07-25T11:51:04.000Z (over 1 year ago)
• Last Synced: 2024-12-22T17:15:31.188Z (about 7 hours ago)
• Topics: bittorrent, bittorrent-client, bittorrent-network, p2p, peer-2-peer, peer-to-peer, python, python-3, torrent
• Language: Python
• Homepage:
• Size: 166 KB
• Stars: 323
• Watchers: 12
• Forks: 87
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# PyTorrent

PyTorrent is a CLI tool that downloads files from the **BitTorrent** network.

I wanted to make my own functional and straightforward program to learn how does BitTorrent protocol work and improve my python skills.

It is almost written from scratch with python 3.7, only the pubsub library was used to create events when a new peer is connected, or when data is received from a peer.

You first need to wait for the program to connect to some peers first, then it starts downloading.

This tool needs a lot of improvements, but it does its job, you can :

-	Read a torrent file

-	Scrape udp or http trackers

-	Connect to peers

-	Ask them for the blocks you want

-	Save a block in RAM, and when a piece is completed and checked, write the data into your hard drive

-	Deal with the one-file or multi-files torrents

-	Leech or Seed to other peers

But you can’t :

-	Download more than one torrent at a time

-	Benefit of a good algorithm to ask your peers for blocks (code of rarest piece algo is implemented but not used yet)

-	Pause and resume download

Don't hesitate to ask me questions if you need help, or send me a pull request for new features or improvements.

### Installation

You can run the following command to install the dependencies using pip

`pip install -r requirements.txt`

:boom: Because it's using the "select" function, this code will not be able to run on Windows: [python-select-on-windows](https://stackoverflow.com/a/22254123/3170071)

### Running the program

Simply run:

`python main.py /path/to/your/file.torrent`

The files will be downloaded in the same path as your main.py script.

### Sources :

I wouldn't have gone that far without the help of

[Lita](https://github.com/lita/bittorrent "Lita"), 

[Kristen Widman's](http://www.kristenwidman.com/blog/how-to-write-a-bittorrent-client-part-1 "Kristen Widman's blog") & the

[Bittorrent Unofficial Spec](https://wiki.theory.org/BitTorrentSpecification "Bittorrent Unofficial Spec"), so thank you.