https://github.com/kietcse/quickseed

https://github.com/kietcse/quickseed

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kietcse/quickseed
• Owner: KietCSE
• Created: 2024-10-22T02:29:01.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-12-09T17:24:45.000Z (about 1 month ago)
• Last Synced: 2024-12-09T18:19:41.921Z (about 1 month ago)
• Language: Python
• Size: 40 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Torrent-app

Build and developed a CLI torrent app enabling simultaneous file sharing and downloading. Files were split into multiple pieces and distributed concurrently across clients in the network. This repo associate with tracker repo.

## Available Commands:

    -------------------------

    - add                 : Publish your documents into network

    - delete        : Delete your published documents

    - ls                  : List all your published documents 

    - seed          : Start sharing your documents 

    - get           : Start downloading documents

    - peers         : List all peers you are connecting 

    - scrape        : Check currrent infomation of torrent network

    - help                : Display available commands

    - clear               : Clear the screen

    - logout              : Log out your account 

    - exit                : Exit the program


## User manual

First, you go to **dist** folder, double click on *window.exe* if you are on Window or run command *./linux* if you are on Linux

1. Login or create your account 

2. Copy link of your document you want to share 

3. Using 'add' command to start seeding, share your magnet code for your friend so they can get your document.

![Add command](./public/add.png)

4. On another computer in the same LAN network, people using 'get' command to get document with magnet code

![Add command](./public/get.jpg)

5. The document transfers successfully and is stored in './dist/dist'

6. You can use other command to check torrent network 

![Add command](./public/peers.png)

## Virtual environment setup and run project

Create venv

```sh

python -m venv venv

```

Active venv for window

```sh

venv\Scripts\activate

```

Active for Linux/MacOS

```sh

source venv/bin/activate

```

Install dependencies

```sh

pip install -r requirements.txt

```

Run project 

```sh

python main.py

```

**Notice**: you need create a `.env` file with all variable in `.env.example` but with actual value, you also need a tracker server for everything go well 

## Project structure

```py

📦src

 ┣ 📄 .env.example                  # all environment variables in program

 ┣ 📄 add_delete_ls.py              # add + delete + ls command

 ┣ 📄 auth.py                       # login + register command 

 ┣ 📄 config.py                     # Load environment variable 

 ┣ 📄 fetch_api.py                  # fetch + post + delete API function

 ┣ 📄 get_seed_peers.py             # get + seed + peers commands  

 ┣ 📄 scrape.py                     # scrape command

 ┣ 📄 show.py                       # show command 

 ┣ 📄 upload.py                     # Upload algorithm 

 ┣ 📄 download.py                   # download handler

 ┣ 📄 split.py                      # split, merge, get piece, save piece

 ┣ 📄 makeChoice.py                 # rarest first 

 ┣ 📄 state.py                      # current state of peer              

 ┣ 📄 requirement.txt               # all libraries and version for this program  

 ┗ 📜 main.py                       # main file to run program

```