cyberflamego / magic-wormhole

get things from one computer to another, safely

Magic Wormhole

Get things from one computer to another, safely.

This package provides a library and a command-line tool named wormhole, which makes it possible to get arbitrary-sized files and directories (or short pieces of text) from one computer to another. The two endpoints are identified by using identical "wormhole codes": in general, the sending machine generates and displays the code, which must then be typed into the receiving machine.

The codes are short and human-pronounceable, using a phonetically-distinct wordlist. The receiving side offers tab-completion on the codewords, so usually only a few characters must be typed. Wormhole codes are single-use and do not need to be memorized.

• PyCon 2016 presentation: Slides, Video

For complete documentation, please see https://magic-wormhole.readthedocs.io or the docs/ subdirectory.

This program uses two servers, whose source code is kept in separate repositories: the mailbox server, and the transit relay.

License, Compatibility

Magic-Wormhole is released under the MIT license, see the LICENSE file for details.

This library is compatible with Python 3.6 and higher (tested against 3.6, 3.7, 3.8, and 3.9). It also still works with Python 2.7 and 3.5, although these are no longer supported by upstream libraries like Cryptography, so it may stop working at any time.

Packaging, Installation

Magic Wormhole packages are included in many operating systems.

To install it without an OS package, follow the Installation docs.