2015-04-10 04:58:31 +00:00
|
|
|
# Magic Wormhole
|
2018-02-18 03:37:25 +00:00
|
|
|
[](https://pypi.python.org/pypi/magic-wormhole)
|
2015-09-28 23:23:19 +00:00
|
|
|
[](https://travis-ci.org/warner/magic-wormhole)
|
2017-11-02 18:44:55 +00:00
|
|
|
[](https://ci.appveyor.com/project/warner/magic-wormhole)
|
2016-03-02 22:42:19 +00:00
|
|
|
[](https://codecov.io/github/warner/magic-wormhole?branch=master)
|
2017-11-12 23:43:50 +00:00
|
|
|
[](https://magic-wormhole.readthedocs.io)
|
2015-03-24 06:38:47 +00:00
|
|
|
|
2015-04-10 04:58:31 +00:00
|
|
|
Get things from one computer to another, safely.
|
|
|
|
|
|
|
|
|
|
This package provides a library and a command-line tool named `wormhole`,
|
2017-06-24 14:59:48 +00:00
|
|
|
which makes it possible to get arbitrary-sized files and directories
|
2017-05-24 15:40:43 +00:00
|
|
|
(or short pieces of text) from one computer to another. The two endpoints are
|
2015-12-03 23:02:34 +00:00
|
|
|
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.
|
2015-04-10 04:58:31 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2016-10-23 18:48:27 +00:00
|
|
|
* PyCon 2016 presentation: [Slides](http://www.lothar.com/~warner/MagicWormhole-PyCon2016.pdf), [Video](https://youtu.be/oFrTqQw0_3c)
|
2016-06-01 00:43:49 +00:00
|
|
|
|
2017-11-12 23:21:56 +00:00
|
|
|
For complete documentation, please see https://magic-wormhole.readthedocs.io
|
|
|
|
|
or the docs/ subdirectory.
|
2017-06-28 18:47:20 +00:00
|
|
|
|
2015-04-10 04:58:31 +00:00
|
|
|
## License, Compatibility
|
|
|
|
|
|
|
|
|
|
This library is released under the MIT license, see LICENSE for details.
|
|
|
|
|
|
2018-02-27 01:23:27 +00:00
|
|
|
This library is compatible with python2.7, 3.4 (non-Windows-only), 3.5, and
|
|
|
|
|
3.6 .
|
