https://github.com/magic-wormhole/magic-wormhole

get things from one computer to another, safely
https://github.com/magic-wormhole/magic-wormhole

Last synced: 9 days ago
JSON representation

get things from one computer to another, safely

• Host: GitHub
• URL: https://github.com/magic-wormhole/magic-wormhole
• Owner: magic-wormhole
• License: mit
• Created: 2015-02-10T08:38:44.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2025-04-09T18:51:09.000Z (17 days ago)
• Last Synced: 2025-04-17T03:00:32.363Z (10 days ago)
• Language: Python
• Size: 3.32 MB
• Stars: 21,062
• Watchers: 219
• Forks: 673
• Open Issues: 172
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • Contributing: docs/CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• stars - magic-wormhole/magic-wormhole
• awesome-repositories - magic-wormhole/magic-wormhole - get things from one computer to another, safely (Python)
• awesome-switching - magic-wormhole
• awesome-starts - magic-wormhole/magic-wormhole - get things from one computer to another, safely (Python)
• Awesome - `wormhole` (Get things from one computer to another, safely)
• awesome-hacking-lists - magic-wormhole/magic-wormhole - get things from one computer to another, safely (Python)
• awesome-starred - magic-wormhole/magic-wormhole - get things from one computer to another, safely (others)
• my-awesome-github-stars - magic-wormhole/magic-wormhole - get things from one computer to another, safely (Python)

README

        
# Magic Wormhole

[![PyPI](http://img.shields.io/pypi/v/magic-wormhole.svg)](https://pypi.python.org/pypi/magic-wormhole)

![Tests](https://github.com/magic-wormhole/magic-wormhole/workflows/Tests/badge.svg)

[![Windows Build Status](https://ci.appveyor.com/api/projects/status/w1bdniovwm4egfyg/branch/master?svg=true)](https://ci.appveyor.com/project/warner/magic-wormhole)

[![codecov.io](https://codecov.io/github/magic-wormhole/magic-wormhole/coverage.svg?branch=master)](https://codecov.io/github/magic-wormhole/magic-wormhole?branch=master)

[![Docs](https://readthedocs.org/projects/magic-wormhole/badge/?version=latest)](https://magic-wormhole.readthedocs.io)

[![Irc](https://img.shields.io/badge/irc.libera.chat-%23magic--wormhole-brightgreen)](https://web.libera.chat/)

[![Matrix](https://img.shields.io/badge/matrix.org-%23magic--wormhole-brightgreen)](https://matrix.to/#/#magic-wormhole:matrix.org)

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](http://www.lothar.com/~warner/MagicWormhole-PyCon2016.pdf), [Video](https://youtu.be/oFrTqQw0_3c)

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](https://github.com/magic-wormhole/magic-wormhole-mailbox-server),

and the

[transit relay](https://github.com/magic-wormhole/magic-wormhole-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

versions up to 3.12).

## Packaging, Installation

Magic Wormhole packages are included in many operating systems.

[![Packaging status](https://repology.org/badge/vertical-allrepos/magic-wormhole.svg)](https://repology.org/project/magic-wormhole/versions)

To install it without an OS package, follow the [Installation docs](https://magic-wormhole.readthedocs.io/en/latest/welcome.html#installation).