Skip to main content

A local file sharing utility written in Python. Uses multicast UDP to share the list of files, and TCP to transfer the files themselves.

Project description

simpleshare

A local file sharing utility written in Python. Uses multicast UDP to share the list of files, and TCP to transfer the files themselves.

Installation:

  • Source:

    • Install Python 3
    • $ git clone https://github.com/ssebs/simpleshare
      $ cd simpleshare/
      $ python -m venv venv
      
    • Linux:
      • $ source ./venv/bin/activate
    • Windows:
      • > .\venv\Scripts\activate
    • (venv) $ pip install -r requirements.txt
      
  • Binary:

  • PyPI:

    • $ pip install simpleshare
    • $ simpleshare

Usage:

  • CLI
    usage: simpleshare.py [-h] [--type {client,server}] [--ip IP] [FILENAME]
    
    Local file sharing utility. Can be used as server and as a client. Run this
    without any arguments to run GUI.
    
    positional arguments:
      FILENAME              Name of the file you want to share, if running as the
                            server.
    
    optional arguments:
      -h, --help            show this help message and exit
      --type {client,server}
                            Type, how do you want to use this tool
      --ip IP               IP address, only used if you're the server
    
  • GUI
    • Double click the exe / binary.

Building

  • Linux:
    • $ make
  • Windows:
    • > .\Makefile.bat
  • (venv) $ pyinstaller simpleshare/__main__.py --clean -F -n simpleshare

Screenshots

Home

home

Upload

upload

Download

download

TODO:

  • [x] Structure program
    • [x] 3 connections
      • [x] Server: Share filename (Multicast)
      • [x] Client: Reply to server saying that you want the file (UDP)
      • [x] Server: Send file to client (TCP)
    • [x] CLI
    • [x] GUI
  • Server
    • [x] "Broadcast" (multicast) that you're sharing "x" file
    • [x] Have server send files if requested to IP found.
    • [x] CLI
    • [x] GUI
      • [ ] DnD
      • [x] Custom timout
  • Client
    • [x] Listen to see if anyone is sharing files
    • [x] List available files
    • [x] Download files to specified file name/path
    • [x] CLI
    • [x] GUI
  • [x] Make this work with 1 file, 1 client
  • [ ] Make this work with 1 file, 2 clients
  • [ ] Make this work with 2 files (2 servers), 1 client
  • [ ] Make this work with 2 files (2 servers), 2 client
  • [x] Binary output (.exe, .app, etc.)
    • [ ] Icon support
  • [ ] Refactor + document
  • [ ] Unit Tests

Bugs:

  • [ ] Threads won't stop properly
  • [ ] Can't have 2 clients
  • [ ] Can't have 2 servers
  • GUI
    • [ ] Styling
    • [x] Only Choose IP if more than 1 available
    • [ ] Share Thread issues

License

MIT © 2019 Sebastian Safari

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for simpleshare, version 1.3
Filename, size File type Python version Upload date Hashes
Filename, size simpleshare-1.3-py3-none-any.whl (10.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size simpleshare-1.3.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page