| Name | shwim JSON |
| Version |
25.7.0
JSON |
| download |
| home_page | None |
| Summary | Encrypted, peer-to-peer terminal sharing for two people. |
| upload_time | 2025-07-30 18:00:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | The MIT License (MIT)
Copyright (c) 2023 meejah
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
fowl
magic-wormhole
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ShWiM
=====
``SHell WIth Me`` lets a “host” share their terminal with a “guest” peer
on another computer.
This combines the cryptography of `Magic Wormhole
<http://magic-wormhole.io>`_ (via `Fowl
<https://github.com/meejah/fowl>`_) and the terminal-sharing of
`tty-share <https://tty-share.com/>`_ into a secure, end-to-end
encrypted, **peer-to-peer terminal sharing application**.
.. image:: media/logo-shell-256.png
:width: 256px
:align: right
:alt: the ShWiM logo, the chicken head from Fowl's logo peeking out of a conch-looking shell
Getting Started
---------------
To install, use ``pip install shwim`` (see longer instructions below).
This should enable you to run ``shwim --help``.
The *Host* computer runs ``shwim`` by itself, producing a
``<magic-code>``. The *Guest* computer runs ``shwim <magic-code>``.
You are now sharing a single terminal running on “host”. **Beware**: the
guest can type, run commands, etc. so only do this with humans you would
hand your local keyboard over to.
Slightly Longer Explanation
---------------------------
Once thetwo things happen (i.e. “shwim” on the host and “shwim ” on the
guest), there is a secure tunnel between both computers. The host will
decide a random port and run ``tty-share`` as a server; the guest will
run ``tty-share`` as a client.
On both computers, ``tty-share`` will be running as a subprocess with
correct options to do networking via Magic Wormhole only. All raw-mode
terminal I/O is forwarded to this ``tty-share`` process so things like
curses etc work as expected.
Once either side exits, the networking forwarding is done – there is no
long-term credential sharing or any other network set preserved or
altered on the “host” nor “guest” computers.
Raw data
{
"_id": null,
"home_page": null,
"name": "shwim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "fowl, magic-wormhole",
"author": null,
"author_email": "meejah <meejah@meejah.ca>",
"download_url": "https://files.pythonhosted.org/packages/e7/5c/a144cfc8ed213be9a26662e1af4dbceeb6f6037decf9c2c48f7f9ba0ef08/shwim-25.7.0.tar.gz",
"platform": null,
"description": "ShWiM\n=====\n\n``SHell WIth Me`` lets a \u201chost\u201d share their terminal with a \u201cguest\u201d peer\non another computer.\n\nThis combines the cryptography of `Magic Wormhole\n<http://magic-wormhole.io>`_ (via `Fowl\n<https://github.com/meejah/fowl>`_) and the terminal-sharing of\n`tty-share <https://tty-share.com/>`_ into a secure, end-to-end\nencrypted, **peer-to-peer terminal sharing application**.\n\n.. image:: media/logo-shell-256.png\n :width: 256px\n :align: right\n :alt: the ShWiM logo, the chicken head from Fowl's logo peeking out of a conch-looking shell\n\n\n\nGetting Started\n---------------\n\nTo install, use ``pip install shwim`` (see longer instructions below).\nThis should enable you to run ``shwim --help``.\n\nThe *Host* computer runs ``shwim`` by itself, producing a\n``<magic-code>``. The *Guest* computer runs ``shwim <magic-code>``.\n\nYou are now sharing a single terminal running on \u201chost\u201d. **Beware**: the\nguest can type, run commands, etc. so only do this with humans you would\nhand your local keyboard over to.\n\n\nSlightly Longer Explanation\n---------------------------\n\nOnce thetwo things happen (i.e.\u00a0\u201cshwim\u201d on the host and \u201cshwim \u201d on the\nguest), there is a secure tunnel between both computers. The host will\ndecide a random port and run ``tty-share`` as a server; the guest will\nrun ``tty-share`` as a client.\n\nOn both computers, ``tty-share`` will be running as a subprocess with\ncorrect options to do networking via Magic Wormhole only. All raw-mode\nterminal I/O is forwarded to this ``tty-share`` process so things like\ncurses etc work as expected.\n\nOnce either side exits, the networking forwarding is done \u2013 there is no\nlong-term credential sharing or any other network set preserved or\naltered on the \u201chost\u201d nor \u201cguest\u201d computers.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) 2023 meejah\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Encrypted, peer-to-peer terminal sharing for two people.",
"version": "25.7.0",
"project_urls": null,
"split_keywords": [
"fowl",
" magic-wormhole"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e75ca144cfc8ed213be9a26662e1af4dbceeb6f6037decf9c2c48f7f9ba0ef08",
"md5": "cf36f3d82a22cbb0bc40cb07a661ab6b",
"sha256": "23729e65890a6e8d4f3c55df4f4ea5b4db01c5bbcdfa05503c89069adb844568"
},
"downloads": -1,
"filename": "shwim-25.7.0.tar.gz",
"has_sig": false,
"md5_digest": "cf36f3d82a22cbb0bc40cb07a661ab6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4887,
"upload_time": "2025-07-30T18:00:28",
"upload_time_iso_8601": "2025-07-30T18:00:28.700298Z",
"url": "https://files.pythonhosted.org/packages/e7/5c/a144cfc8ed213be9a26662e1af4dbceeb6f6037decf9c2c48f7f9ba0ef08/shwim-25.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 18:00:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "shwim"
}
