README.md
1# Magic Wormhole
2[](https://pypi.python.org/pypi/magic-wormhole)
3[](https://travis-ci.org/warner/magic-wormhole)
4[](https://ci.appveyor.com/project/warner/magic-wormhole)
5[](https://codecov.io/github/warner/magic-wormhole?branch=master)
6[](https://magic-wormhole.readthedocs.io)
7
8Get things from one computer to another, safely.
9
10This package provides a library and a command-line tool named `wormhole`,
11which makes it possible to get arbitrary-sized files and directories
12(or short pieces of text) from one computer to another. The two endpoints are
13identified by using identical "wormhole codes": in general, the sending
14machine generates and displays the code, which must then be typed into the
15receiving machine.
16
17The codes are short and human-pronounceable, using a phonetically-distinct
18wordlist. The receiving side offers tab-completion on the codewords, so
19usually only a few characters must be typed. Wormhole codes are single-use
20and do not need to be memorized.
21
22* PyCon 2016 presentation: [Slides](http://www.lothar.com/~warner/MagicWormhole-PyCon2016.pdf), [Video](https://youtu.be/oFrTqQw0_3c)
23
24For complete documentation, please see https://magic-wormhole.readthedocs.io
25or the docs/ subdirectory.
26
27## License, Compatibility
28
29Magic-Wormhole is released under the MIT license, see the `LICENSE` file for details.
30
31This library is compatible with Python 3.5 and higher (tested against 3.5,
323.6, 3.7, and 3.8). It also still works with Python 2.7.
33
34## Packaging, Installation
35
36Magic Wormhole packages are included in many operating systems.
37
38[](https://repology.org/project/magic-wormhole/versions)
39
40To install it without an OS package, follow the [Installation docs](https://magic-wormhole.readthedocs.io/en/latest/welcome.html#installation).
41
){kind=link}
){kind=link}
){kind=link}
){kind=link}