unseenet-gui 0.1.0__tar.gz

unseenet_gui-0.1.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

unseenet_gui-0.1.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: unseenet-gui
+Version: 0.1.0
+Summary: The graphical client for Unseenet: groups and chat in a window, Tor and keys stay in the unseenet core
+Author: Andreas Lorensen
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/unseenet/unseenet-gui
+Project-URL: Unseenet, https://unseenet.org/
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Usenet News
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: unseenet[api]<0.5,>=0.4.1
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: window
+Requires-Dist: pywebview>=5; extra == "window"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/img/logo-dark.svg">
+    <img src="docs/img/logo-light.svg" alt="Unseenet" width="320">
+  </picture>
+</p>
+
+<p align="center"><b>Usenet, unseen - now in a window.</b><br>
+Discussions you read and answer, chats you chat in, over Tor. Portable on Windows, macOS and Linux, booted from a USB stick - or in any browser, on a phone too, through a web entrance.</p>
+
+<p align="center">
+  <img src="docs/img/demo.gif" alt="Unlocking the vault, reading down a thread post by post, replying with a quote, chatting, the command palette and the light theme" width="880">
+</p>
+
+A modern client for [Unseenet](https://unseenet.org), the decentralised,
+encrypted discussion network over Tor onion services, built on the
+[unseenet](https://github.com/unseenet/unseenet) core with the look of
+[unseenet.org](https://unseenet.org).
+
+> **Pre-alpha prototype.** Neither this client nor the unseenet core has had a
+> security review. Play with it, pick it apart - do not rely on it to protect
+> anyone yet.
+
+A discussion is not a chat. Discussion groups work like a newsreader - the
+same way as unseenet's terminal client: the posts as a tree, the selected one
+below to read, `↑` `↓` through the thread and `Space` to the next unread, and
+`R` to answer in a compose window with the post quoted and your signature
+below. Chat groups are chats. The group's owner decides which a group is, and
+`V` lets you see it the other way.
+
+| Read a discussion | Answer it, quoting |
+|---|---|
+| ![A discussion group: the posts as a tree, the selected post below with its quote](docs/img/threads.png) | ![The compose window: the post quoted with "wrote:", your answer, your signature below](docs/img/reply.png) |
+| **Chat where it is a chat** | **Light, or dark** |
+| ![A chat group: messages in order, and one that has reached the node](docs/img/chat.png) | ![The light theme](docs/img/light.png) |
+
+### Booted from a stick
+
+<p align="center">
+  <img src="docs/img/boot.gif" alt="The boot splash, then the client full screen with network, keyboard and power at the top" width="880">
+</p>
+
+The bootable image starts with the Unseenet splash and then the client full
+screen - network, Wi-Fi, keyboard and power at the top. The splash is the
+image's own; the picture of the client is taken by the image's self-test, which
+boots it in QEMU on every build.
+
+### In a browser, on a phone or a computer
+
+The same client runs in an ordinary browser, with nothing to install, through
+a **web entrance** ([unseenet-entrance](https://github.com/unseenet/unseenet-entrance),
+UN-RFC 0043) - for example the project's own, **https://129.151.209.26/**.
+There the client's Python backend - this repository's server code and the
+unseenet core - runs in the browser itself (WebAssembly), so the keys stay in
+the browser; the entrance only carries the connections to the nodes over Tor.
+It can be added to the home screen like an app, keeps the vault on the
+device if you want, and updates itself to signed versions. The entrance sees
+your IP address (not in Tor Browser), and the page says so at all times: for
+the hidden way in, use the portable client or the stick.
+
+On a narrow screen - a phone - the client shows one thing at a time: your
+groups, then a group, then a post or the chat. **⋯** holds what does not fit,
+and the compose window has its Send button at the top, above the keyboard.
+
+## How it works
+
+```
+ browser window ──HTTP/WebSocket──▶ unseenet-gui ──▶ unseenet core ──Tor──▶ nodes
+ (127.0.0.1 only)                   (local server)   vault, keys, postage
+```
+
+`unseenet-gui` is a small local server around the core's `Session` - the same
+one the TUI uses. (On the web the same server code runs inside the browser
+instead, see above; nothing in this repository is different for it.) It opens the same encrypted vault, starts the same bundled
+Tor and talks to the same nodes. The browser only draws what you would see on
+screen: **keys, signing, encryption and postage never leave Python**, and the
+passphrase is only sent once, to unlock.
+
+The client follows the terminal client's way of working, so you can switch
+between them without learning anything new: the same keys, the same icons
+(`≡` discussion, `»` chat, `∩` closed), the same compose window.
+
+## Download
+
+Every push to `main` is built and self-tested; the newest builds are the
+[development pre-release](https://github.com/unseenet/unseenet-gui/releases/tag/dev).
+
+- **Portable** - unzip and start, from a USB stick or a folder. Tor is included,
+  and everything stays in `data/` beside the programs.
+  `unseenet-gui-…-usb.zip` has every platform; or take only yours:
+  - Windows: `Unseenet Graphical.exe` (an app window through WebView2, no console)
+  - macOS: `Start Unseenet Graphical.command` (an app window)
+  - Linux: `sh start-graphical-linux.sh` (Chromium, Chrome, Edge or Brave without
+    tabs if you have one, else your browser)
+- **Bootable** - `unseenet-gui-…-x86_64.img.xz`: write it to a USB stick (for
+  example with Raspberry Pi Imager, balenaEtcher or
+  `xz -dc FILE | sudo dd of=/dev/sdX bs=4M`), boot from it, and Unseenet starts
+  full screen and runs from memory. Set up Wi-Fi and the keyboard on the first
+  screen. The same stick also starts the portable client on a running
+  computer, with the same `data/`. It needs 4 GB of memory; "safe graphics" in
+  the boot menu helps if the screen stays black, and "text only" starts
+  unseenet's terminal client instead.
+
+Both use the same `Unseenet/` folder and `data/` as unseenet's own portable
+build, so the terminal client and this one can share a stick and a vault.
+
+## From source
+
+You need Python 3.11+.
+
+```sh
+pip install unseenet-gui
+unseenet-gui                        # opens your browser
+unseenet-gui --vault /path/to/unseenet.vault
+```
+
+It uses the same vault as the TUI (`unseenet.vault` in the current folder, or
+the portable build's `data/`), so your identity, groups and read marks are the
+same in both. Do not run both on the same vault at the same time.
+
+### In its own window
+
+```sh
+pip install "unseenet-gui[window]"
+unseenet-gui --window
+```
+
+This uses [pywebview](https://pywebview.flowrl.com/): the system's web view
+(WebView2 on Windows, WebKit on macOS and Linux) in private mode, so nothing
+ends up in your browser's history or cache. On Linux it needs the GTK WebKit
+libraries.
+
+### A playground without Tor
+
+```sh
+git clone https://github.com/unseenet/unseenet-gui && cd unseenet-gui
+pip install -e .
+tools/dev.sh            # a local node, three people, groups and a closed chat
+```
+
+Passphrase `test`. Everything is in `./dev`; `tools/dev.sh clean` deletes it.
+
+## Keys
+
+| Key | |
+|---|---|
+| `Ctrl K` or `Ctrl P` | Commands and groups |
+| `N` | New post |
+| `R` | Reply: a compose window with the post quoted |
+| `↑` `↓` | Previous / next post in the tree |
+| `Space` | Next unread post (then the next group with unread posts) |
+| `Enter` | Read the post full screen (`Esc` goes back); in a chat: write |
+| `M` | Write to someone (paste their key) |
+| `V` | Switch between chat and threads |
+| `G` | Find groups on your nodes |
+| `K` | Show your key |
+| `?` | About this group |
+| `Ctrl S` | Send, in the compose window |
+| `Esc` | Leave the text box, close a dialog |
+
+## Security
+
+The local server is reachable from your own computer, so it guards itself.
+These are the rules of UN-RFC 0046, kept by the core's local API:
+
+- It listens on **127.0.0.1 only**, on a random port.
+- Every start makes a **random token**. It is in the address the client opens
+  (`…/#t=…`, in the fragment, so it is never sent in a request line), kept in
+  that tab only and removed from the address bar. Every API call and the
+  event socket must carry it. Other programs on the computer and web pages in
+  your browser do not know it.
+- The **Host** header must be our own address, which stops DNS rebinding, and
+  an **Origin** header, when sent, must be our own origin.
+- A strict **Content-Security-Policy**: the page loads nothing from anywhere
+  but the local server - no fonts, images, scripts or styles from outside. A
+  post can never make the browser fetch something past Tor.
+- Everything people wrote is put on the page as text, never as HTML, and links
+  in posts are not clickable: following one would leave Tor.
+- Nothing is logged: the server has no access log.
+
+What it does **not** protect against: someone who can read your screen, run
+programs as you or read your memory. When you run it in your normal browser,
+the window title and address can end up in its history - `--window` avoids
+that.
+
+## What the prototype can and cannot do
+
+It can: unlock or create a vault, choose a name and node, follow and leave
+groups, read threads and chats (closed groups decrypted), post, reply, chat,
+"For you", private messages (write to anyone by key, conversations as chats,
+private replies), contacts, create groups (open, moderated, channel, closed;
+threads or chat; fast delivery), invite to your closed groups, your signature,
+edit your own posts, names (@you), moderation, roles, bans and member removal, reporting, ignoring people,
+a light and a dark theme, the command palette, and phones and other narrow
+screens. On the bootable image also: network and Wi-Fi, keyboard layout,
+restart and shut down. In a browser: everything above, through a web entrance.
+
+Not yet - use the TUI: Tor bridges and several identities. **Updating**
+a stick or portable folder of this client is not there yet either: its builds
+are not signed yet, and unseenet's own updater does not touch them (it would
+remove the graphical client). Download the new build from the
+[releases](https://github.com/unseenet/unseenet-gui/releases) for now; signed
+builds, a notice and an Update button (already in the code, switched off)
+are coming (unseenet#264).
+
+## Versions and releases
+
+Versions follow [semantic versioning](https://semver.org/) on the same
+principles as [unseenet](https://github.com/unseenet/unseenet/blob/main/docs/development.md#versioning):
+tags `vX.Y.Z` on `main`, the changes in [CHANGELOG.md](CHANGELOG.md), and
+releases on [PyPI](https://pypi.org/p/unseenet-gui) and here with the
+portable builds and the image. Each release names the minor version of
+unseenet it works with (`unseenet[api]>=0.4.1,<0.5`).
+
+To release: move the entries under `## [Unreleased]` in `CHANGELOG.md` to a
+new `## [X.Y.Z] - YYYY-MM-DD` section, set `__version__` in
+`src/unseenet_gui/__init__.py`, and the core release the builds use
+(`CORE_REF` in `.github/workflows/build.yml`); commit, then
+`git tag -a vX.Y.Z -m "unseenet-gui X.Y.Z" && git push origin vX.Y.Z`.
+`release.yml` publishes to PyPI and makes the release with the changelog
+notes, `build.yml` adds the builds. Afterwards set `__version__` on main to
+the next `.dev0`, so development builds are named after it.
+
+## Built on the core
+
+Everything but the page is the core's: this client is unseenet's local
+client API (UN-RFC 0046, `unseenet.client.localapi`) with its page and a few
+routes of its own under `/x/gui/` - the bootable image's network, keyboard and
+power, updating, and what the page shows about this machine. The same runtime,
+threads, names and safe Markdown tree serve every front end, so this client
+shows what the TUI shows. [CORE-NEEDS.md](CORE-NEEDS.md) records how it got there.
+
+## Layout
+
+```
+src/unseenet_gui/
+  __main__.py     command line: how to open it, --self-test
+  opening.py      app window, browser in app mode, or the browser
+  server.py       the core's local API with this page, and /x/gui/
+  update.py       updating a stick or portable folder (off for now)
+  system.py       the bootable image's network, keyboard and power
+  boot.py         the bootable image's session (cage) and its self-test
+  splash.py       the boot splash, drawn on the framebuffer
+  selftest.py     does this build work?
+  static/         the page: index.html, app.css, app.js (no build step)
+tests/            the server: the core's guards, the page, /x/gui/
+tools/
+  dev.sh          a playground without Tor (seed_dev.py fills it)
+  record_demo.py  the demo and screenshots in this README, from the playground
+  build_portable.py, portable/   the portable builds (with unseenet's Tor tooling)
+  image/          the bootable image (adapted from unseenet's)
+.github/workflows/build.yml      Tor, four portable builds, USB zip, image, releases
+```
+
+The front end is plain JavaScript with no dependencies and no build step, so
+the client is easy to read and audit.
+
+Code Apache-2.0. Logo CC BY 4.0, from the Unseenet project.