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 pyshareit

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

Start sender

On the computer that will send the file, type:

pyshare> connect

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:

```bash
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"

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.11.0.tar.gz (22.2 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.11.0-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyshareit-1.11.0.tar.gz
Algorithm Hash digest
SHA256 c5745f0748c8389fd818790770167849282f6a1d642d12021bde1bb904087723
MD5 7e7badf61c02cfa018f4f046eef8bce2
BLAKE2b-256 adb5995a6f2ef52bcb0133169411155cfe09cdc8211d7ed6eebf628a1a61b58c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyshareit-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 22.5 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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 772b216deffab2ad0a539730a5cce7fdb60050e42f729bef8d934d43bc41025e
MD5 0036e43545a47f235398b05653290615
BLAKE2b-256 9f782703ef5cc4462c6008a1efe6308a09e1358a2080ec57725752d08e267a20

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