open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
get things from one computer to another, safely
1,525 Commits 1 Branch 0 Tags 2.9 MiB
Python 95.4%
JavaScript 4.3%
CSS 0.1%
65237a8ecf
Go to file
a1346054 65237a8ecf trim trailing whitespace
2021-08-25 19:19:52 +00:00
.github/workflows add GitHub Actions -based CI 2021-01-10 14:08:23 -08:00
docs trim trailing whitespace 2021-08-25 19:19:52 +00:00
misc trim trailing whitespace 2021-08-25 19:19:52 +00:00
pyi trim trailing whitespace 2021-08-25 19:19:52 +00:00
src/wormhole trim trailing whitespace 2021-08-25 19:19:52 +00:00
.appveyor.yml fix spelling 2021-08-25 19:19:21 +00:00
.coveragerc add 'coverage' environment for tox 2016-05-24 16:03:39 -07:00
.gitattributes initial setup.py, versioneer-ification 2015-02-10 00:48:19 -08:00
.gitignore use pyinstaller to build wormhole fat/standalone binary 2018-06-02 18:05:45 +02:00
.travis.yml tox/travis: test py3.8 too 2020-04-04 13:49:52 -07:00
LICENSE Initial commit 2015-02-10 00:38:44 -08:00
MANIFEST.in MANIFEST.in: add some missing files 2018-10-16 16:29:24 -07:00
NEWS.md trim trailing whitespace 2021-08-25 19:19:52 +00:00
README.md more roundy-brackets 2021-06-17 10:28:36 -06:00
setup.cfg trim trailing whitespace 2021-08-25 19:19:52 +00:00
setup.py Replace deprecated attrs cmp=False parameter with eq=False (#384) 2020-04-12 14:50:03 -07:00
snapcraft.yaml Merge PR237 2017-07-31 12:29:21 -07:00
tox.ini tox/travis: test py3.8 too 2020-04-04 13:49:52 -07:00
versioneer.py Correct spelling mistakes 2018-11-23 07:38:21 +00:00

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

Packaging status

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