Airshare¶

What is Airshare?¶

Airshare 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.

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 chunk by chunk and never read into memory entirely.
Lets you send files whose paths have been copied into the clipboard (more details in the docs).
Cross-platform, works on Linux, Windows and Mac (CLI and Web Interface), and also supports mobile (Web Interface).
Uses Multicast-DNS service registration and discovery - so you can access content with human-readable code words.
Can be used as a module in other Python programs.

Important Links¶

Source Code: https://github.com/KuroLabs/Airshare
Bug Reports: https://github.com/KuroLabs/Airshare/issues
Documentation: https://airshare.rtfd.io
PyPI: https://pypi.org/project/Airshare

Installation¶

Installation using pip

$ pip install Airshare

Installation using pipx

$ pipx install Airshare

Installation using Homebrew

$ brew install airshare

CLI Tool Reference¶

Airshare CLI Tool
- Usage
- Flags

Module Reference¶

Airshare Module

Examples¶

Examples
- CLI
- Module

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.
Android browsers do not have inbuilt Multicast-DNS service discovery, and cannot resolve the .local addresses. For this reason, we included QR Code support, for you to visit the URLs easily.
Windows users with Python < 3.8, use Ctrl + Break to quit, as Ctrl + C will not work. This is a known issue with asyncio, which has been fixed in Python 3.8. If you do not have a Break key, try using Ctrl + Fn + B, or check the web for other alternatives (depending on your PC).

Contributing¶

Pull requests are welcome. Read our Contribution Guide for more details.

License¶

Airshare is licensed under the terms of the MIT License.

Airshare is the joint work of Kandavel A, Mohanasundar M and Nanda H Krishna.

MIT License

Copyright (c) 2020

Kandavel A <kanduarul@gmail.com>,
Mohanasundar M <itsmohanpierce@gmail.com> and
Nanda H Krishna <nanda.harishankar@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Acknowledgements¶

The Airshare logo was designed by Siddique.

The Airshare GIF was designed by Anam Saatvik.