Metadata-Version: 1.1
Name: pearsend
Version: 0.0.3
Summary: A simple CLI client for peer-to-peer file or message sending
Home-page: https://github.com/SkullTech/PearSend
Author: Sumit Ghosh
Author-email: sumit@sumit-ghosh.com
License: MIT
Description-Content-Type: UNKNOWN
Description: PearSend
        ========
        
        A simple CLI client for peer-to-peer file or message sending. Written in
        Python.
        
        |PyPI version|
        
        Features
        --------
        
        -  It supports file or message of size upto about 8.85 PeB (1 PiB ~ 10^6
           GiB)!.
        -  Protection against transmission error using ``CRC32`` checksum.
        -  Comes with CLI (command-line argument) and Interactive mode, both!
        
        Installation
        ============
        
        Install it using ``pip``
        
        .. code:: console
        
            pip install pearsend
        
        Usage Examples
        ==============
        
        Command-line Mode
        -----------------
        
        **Help Text**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py -h
            usage: pearsend.py [-h] [-i] [-f FILEPATH] [--host HOST] [-p PORT]
                               [-m MESSAGE]
                               {send,receive}
        
            positional arguments:
              {send,receive}        Whether to send or receive
        
            optional arguments:
              -h, --help            show this help message and exit
              -i, --interactive     If the program is to be run in interactive mode
              -f FILEPATH, --filepath FILEPATH
                                    Path of the file to be sent or to save incoming data
                                    to
              --host HOST           Address of the source or target machine
              -p PORT, --port PORT  Port for listening on or sending to
              -m MESSAGE, --message MESSAGE
                                    Message to send
        
        Sending text message
        ~~~~~~~~~~~~~~~~~~~~
        
        **Receiver**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py receive -p 5000
            [*] Listening for connections on: 10.194.52.135:5000
        
            [*] Connection from : 10.194.52.135:47804
            [*] The incoming data is > 
            b'Hello HAL!'
        
        **Sender**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py send --host 10.194.52.135 -m "Hello HAL!"
        
            [*] Sent message succesfully!
        
        Sending binary file
        ~~~~~~~~~~~~~~~~~~~
        
        **Receiver**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py receive -p 5000 -f recd.png
            [*] Listening for connections on: 10.194.52.135:5000
        
            [*] Connection from : 10.194.52.135:47808
            [*] Incoming data saved to recd.png
        
        **Sender**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py send --host 10.194.52.135 -f image.png
        
            [*] Sent message succesfully!
        
        Interactive Mode
        ----------------
        
        Sending text message
        ~~~~~~~~~~~~~~~~~~~~
        
        **Receiver**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py receive -i
            [?] Port to listen on: 
            [?] File to save the incoming data to. Leave blank to output to terminal: 
            [*] Listening for connections on: 10.194.52.135:5000
        
            [*] Connection from : 10.194.52.135:36240
            [*] The incoming data is > 
            b'Hello HAL!'
        
        **Sender**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py send -i
            [?] The address of the target machine: 10.194.52.135
            [?] Enter the port to connect to: 
            [?] The file to send. Leave blank for text message: 
            [?] Enter the message: Hello HAL!
        
            [*] Sent message succesfully!
        
        Sending binary file
        ~~~~~~~~~~~~~~~~~~~
        
        **Receiver**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py receive -i
            [?] Port to listen on: 
            [?] File to save the incoming data to. Leave blank to output to terminal: recd.jpg
            [*] Listening for connections on: 10.194.52.135:5000
        
            [*] Connection from : 10.194.52.135:36242
            [*] Incoming data saved to recd.jpg
        
        **Sender**
        
        .. code:: console
        
            sumit@HAL9000:~/Documents/PearSend$ python3 pearsend.py send -i
            [?] The address of the target machine: 10.194.52.135
            [?] Enter the port to connect to: 
            [?] The file to send. Leave blank for text message: image.jpg
        
            [*] Sent message succesfully!
        
        .. |PyPI version| image:: https://badge.fury.io/py/pearsend.svg
           :target: https://badge.fury.io/py/pearsend
        
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Communications
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
