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:

  • Structure program
    • 3 connections
      • Server: Share filename (Multicast)
      • Client: Reply to server saying that you want the file (UDP)
      • Server: Send file to client (TCP)
    • CLI
    • GUI
  • Server
    • "Broadcast" (multicast) that you're sharing "x" file
    • Have server send files if requested to IP found.
    • CLI
    • GUI
      • DnD
      • Custom timout
  • Client
    • Listen to see if anyone is sharing files
    • List available files
    • Download files to specified file name/path
    • CLI
    • GUI
  • 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
  • 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
    • 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.

Source Distribution

simpleshare-1.3.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

simpleshare-1.3-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file simpleshare-1.3.tar.gz.

File metadata

  • Download URL: simpleshare-1.3.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for simpleshare-1.3.tar.gz
Algorithm Hash digest
SHA256 744a3036eada80aebb34c6514046e85c47e2da510b3313cebdd54e29901329d5
MD5 5b81e86c24dcf1bddd6e82835b2a61e2
BLAKE2b-256 f3af6e37b1151fc8df22c2c1dad1629d77fa5a07008b62285d98a93a527a1efb

See more details on using hashes here.

File details

Details for the file simpleshare-1.3-py3-none-any.whl.

File metadata

  • Download URL: simpleshare-1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for simpleshare-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b004a0fd756b21dceb01a0eefa0f650fedbcd5c0be91fb8626650561d9735337
MD5 7e46831d78baea00c83f8d5073debfa0
BLAKE2b-256 84c2198bfef9669d444315a9dfa6ce97518d58dbf23dc29c25ea26f23a074a4e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page