Skip to main content

A fast, peer-to-peer file sharing tool with a simple terminal interface.

Project description

pyshare-cli v3.0: Secure Interactive File Transfer

pyshare is a modern, secure, and interactive command-line tool for transferring files, folders, and text snippets across your local network. All transfers are protected with end-to-end encryption and a confirmation PIN.

Features

  • Interactive Terminal Session: Run pyshare to enter an intuitive file-sharing environment.
  • End-to-End Encryption: All data is encrypted using a robust RSA+Fernet handshake, ensuring nobody on the network can snoop on your files.
  • Confirmation PIN: A 4-digit PIN is displayed on the receiver's screen and must be confirmed by the sender, preventing accidental transfers.
  • Folder & Multiple File Transfers: Send an entire folder with one command. pyshare automatically zips it, sends it, and unzips it on the other side.
  • Text & Clipboard Sharing: Instantly send a text snippet or your clipboard contents with the send --text and paste commands.
  • Resumable Transfers: If a large file transfer gets interrupted, it will automatically resume from where it left off.
  • Persistent Command History: Press the up and down arrow keys to navigate your command history.
  • Auto-Discovery: Automatically finds other devices on the network running pyshare.
  • Visual Progress Bars: A clean tqdm progress bar shows the status of every transfer.

Installation

You will need Python 3.7+ and pip.

pip install pyshare

To install locally for development from the pyshare-cli directory:

pip install -e .

How to Use

Start the Session

Open a terminal on two devices and run:

pyshare

You will enter the interactive pyshare> prompt.

Start Receiver

On the computer that will receive the file, type:

pyshare> receive

The receiver will start in the background, ready to accept connections.

Send a File, Folder, or Text

On the other computer:

To send a file:

pyshare> send "/path/to/my document.zip"

To send a folder:

pyshare> send "/path/to/my project folder/"

To send text:

pyshare> send --text "Here is the link: https://example.com"

To send your clipboard:

pyshare> paste

Confirm the Transfer

  1. The sender's terminal will discover the receiver. Select it by its ID.
  2. The receiver's terminal will ask for confirmation (y/n).
  3. The sender's terminal will then display a 4-digit PIN. This PIN is shown to the receiver in the previous step, but for security, you should verbally confirm it with the person at the receiver's machine.
  4. Once the PIN is confirmed and the handshake is complete, the encrypted transfer will begin.

Exit

When you are finished, type exit or quit.

License

This project is licensed under the GNU General Public License v3.0 (GPLv3).

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

pyshareit-1.7.0.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyshareit-1.7.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file pyshareit-1.7.0.tar.gz.

File metadata

  • Download URL: pyshareit-1.7.0.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pyshareit-1.7.0.tar.gz
Algorithm Hash digest
SHA256 ce5c99ad438f69377c8a087538987c752a1f37da96254e7659e6a033bdb1b9a6
MD5 759eb84f4953f2c21229d3ee59ada6a0
BLAKE2b-256 19a258b5fad5968b67aeb19ffff2dbe897c40be5a154ece2c897938ed684f150

See more details on using hashes here.

File details

Details for the file pyshareit-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: pyshareit-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pyshareit-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 858f0e3eb8e7266bbadf520a4f874debb22d0f73952eb2160fd4ea651e6bf8e7
MD5 230e403f2060ba39a534c670d41bc49a
BLAKE2b-256 35b7c526fdd321d859777171484ca89764d7474d72528b0994fa9669f2ed5e3d

See more details on using hashes here.

Supported by

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