get things from one computer to another, safely
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
meejah e121ddfc4b
Merge pull request #449 from meejah/448.eol-pythons
2 years ago
.github/workflows remove old pythons 2 years ago
docs metadata/readme updates about dropped versions 2 years ago
misc trim trailing whitespace 3 years ago
pyi trim trailing whitespace 3 years ago
src/wormhole trim trailing whitespace 3 years ago
.appveyor.yml gone on windows too 2 years ago
.coveragerc add 'coverage' environment for tox 8 years ago
.gitattributes initial setup.py, versioneer-ification 9 years ago
.gitignore use pyinstaller to build wormhole fat/standalone binary 6 years ago
.travis.yml tox/travis: test py3.8 too 4 years ago
LICENSE Initial commit 9 years ago
MANIFEST.in MANIFEST.in: add some missing files 6 years ago
NEWS.md remove old pythons 2 years ago
README.md metadata/readme updates about dropped versions 2 years ago
setup.cfg trim trailing whitespace 3 years ago
setup.py metadata/readme updates about dropped versions 2 years ago
snapcraft.yaml Merge PR237 7 years ago
tox.ini remove old pythons 2 years ago
versioneer.py Correct spelling mistakes 5 years ago

README.md

Magic Wormhole

PyPI Tests Windows Build Status codecov.io Docs Irc Matrix

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.

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.8 and higher (tested against 3.8, and 3.9). It also still works with Python 2.7 although that is 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.

Packaging status

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