Metadata-Version: 2.1
Name: Airshare
Version: 0.1.3
Summary: An easy way to share content in a local network.
Home-page: https://github.com/KuroLabs/airshare
Author: Kandavel A, Mohanasundar M, Nanda H Krishna
Author-email: kurolabs.org+airshare@gmail.com
License: UNKNOWN
Description: <h1 align="center">
          <br>
          <img src="https://raw.githubusercontent.com/KuroLabs/Airshare/master/assets/Airshare.svg" alt="Airshare" width="100">
          <br>
          <br>
          <span>Airshare</span>
          <br>
          <br>
        </h1>
        
        <h4 align="center">An easy way to share content in a local network using Multicast-DNS.</h4>
        
        <p align="justify"><b>Airshare</b> is a Python-based CLI tool and module that lets you transfer data between two machines in a local network, P2P, using Multicast-DNS. It also opens an HTTP gateway for other non-CLI external interfaces. It works completely offline! Built with aiohttp and zeroconf.</p>
        
        ## Features
        
        * Blazing fast content transfer within a local network.
        
        * Lets you transfer plain text, send from or receive into your clipboard.
        
        * Supports transfer of multiple files, directories and large files - content is sent chun$
        
        * Lets you send files whose paths have been copied into the clipboard (more details in th$
        
        * Cross-platform, works on Linux, Windows and Mac (CLI and Web Interface), and also suppo$
        
        * Uses Multicast-DNS service registration and discovery - so you can access content with $
        
        * Can be used as a module in other Python programs.
        
        ## Important Links
        
        Source Code: https://github.com/KuroLabs/Airshare <br>
        Bug Reports: https://github.com/KuroLabs/Airshare/issues <br>
        Documentation: https://airshare.rtfd.io <br>
        PyPI: https://pypi.org/project/Airshare <br>
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Airshare.
        
        ```bash
        $ pip install Airshare
        ```
        
        If you have a non-Apple device, consider installing Avahi (for Linux) or Bonjour (for Windows) if you'd like to use Link-local Name Resolution (for the `.local` addresses).
        
        ## Example
        
        Send and receive files and directories.
        
        To send using the CLI,
        
        ```bash
        $ airshare noobmaster requirements.txt
        ```
        To receive using the CLI,
        
        ```bash
        $ airshare noobmaster
        ```
        
        or visit `http://noobmaster.local` in the browser to download.
        
        You can also `import airshare` in any Python program. Visit the documentation for detailed usage instructions.
        
        ## Known Issues
        
        * Link-local Name Resolution (for the `.local` addresses) on non-Apple devices requires Avahi (on Linux) or Bonjour (on Windows). Chances are you already have them, but if you don't, do check the web on how to install them.
        
        * Link-local Name Resolution does not work on Android phones. This is because Android browsers do not have inbuilt Multicast-DNS service discovery. For this reason, we included QR Code support, for you to visit the URLs easily.
        
        * You may have to open up port 80 on your system (in Firewall settings) if not already open - Airshare uses port 80 by default.
        
        * Multiple progress bars for concurrent file uploads using `tqdm` may not work as intended on some terminals, refer to the `tqdm` documentation for more details.
        
        * Windows users with Python < 3.8, use <kbd>Ctrl</kbd> + <kbd>Break</kbd> to quit, as <kbd>Ctrl</kbd> + <kbd>C</kbd> will not work. This is a known issue with `asyncio`, which has been fixed in Python 3.8. If you do not have a <kbd>Break</kbd> key, try using <kbd>Ctrl</kbd> + <kbd>Fn</kbd> + <kbd>B</kbd>, or check the web for other alternatives (depending on your PC).
        
        ## Contributing
        
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        ## License
        
        [MIT](https://github.com/KuroLabs/Airshare/blob/master/LICENSE.md) - Copyright (c) 2020 [Kandavel A](http://github.com/AK5123), [Mohanasundar M](https://github.com/mohanpierce99), [Nanda H Krishna](https://github.com/nandahkrishna)
        
        ## Acknowledgements
        
        The Airshare logo was designed by [Siddique](https://dribbble.com/thesideeq).
        
        The Airshare GIF was created by [Anam Saatvik](https://github.com/kalki7).
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
