tamagonion 0.0.0__tar.gz

tamagonion-0.0.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.3
+Name: tamagonion
+Version: 0.0.0
+Summary: This is Stinky, he's running your Tor relay. He mostly loafs around and browses the Web anonymously, but he's more entertaining to look at than a graph!
+Author: Samuel De Grace
+Author-email: Samuel De Grace <48831884+daxAKAhackerman@users.noreply.github.com>
+Requires-Dist: psutil==7.2.2
+Requires-Dist: stem==1.8.2
+Requires-Python: ==3.14.*
+Description-Content-Type: text/markdown
+
+# Tamagonion
+
+## Instructions
+
+This is Stinky, it's a Tamagonion and it's running your Tor relay. Tamagonions are cyber creatures that have bravely stepped out of the Tor network to learn what life is like in the clearnet and to help you monitor your relay. It mostly loafs around and browses the Web anonymously, but it's more entertaining to look at than a graph!
+
+```
+             ▌▌
+             ▓▓▀
+         ▄▄▄▀▀▀▀▄▄▄
+        █   ─  ─   █
+       █    ▄  ▄    █
+      █     ▀  ▀     █
+      █      ──      █
+      █              █
+       █▄▄▄▄▄▄▄▄▄▄▄▄█
+```
+
+## Activation
+
+To activate the viewport, use the `tamagonion` command as such:
+
+```bash
+# By default, we will try to connect to the control port at 127.0.0.1:9051
+$ uv run tamagonion
+
+# If you use password authentication, you can supply it with -P or with the TAMAGONION_PASSWORD environment variable
+$ uv run tamagonion -P my_password
+$ TAMAGONION_PASSWORD=my_password uv run tamagonion
+
+# If the port is listening somewhere else, you can specify it with -i and -p
+$ uv run tamagonion -i 192.168.0.10 -p 9999
+
+# If you are connecting using a Unix socket, you can point to it with -s
+$ uv run tamagonion -s /var/run/tor/control
+```
+
+## Status check
+
+```
+┌──────────────────────────────────────────────┐
+│Relay nickname: exitafpwrwmm                  │
+│Uptime: 0d 05h 53m 06s                        │
+│Connections (N/L/Co/F/Cl): 0,0,7,0,0          │
+│Download (Cur/Avg/Tot): 338B / 116B / 2MB     │
+│Upload (Cur/Avg/Tot): 1KB / 152B / 3MB        │
+│Version: 0.4.9.11 (none recommended)          │
+│Process info (CPU/Mem): 0.0%/867MB            │
+│                              ░░░░░░░░        │
+│                             ░╔══════╗░   █▄  │
+│             ▌▌          z   ░║ EXIT ║░ █████ │
+│             ▓▓▀        Z    ░╚══════╝░   █▀  │
+│         ▄▄▄▀▀▀▀▄▄▄   Z       ░░░░░░░░        │
+│        █   ─  ─    ▄▄▄▄▄                     │
+│       █           █  █  █                    │
+│      █    ──  ── █  ▀█▀  █  ╓───┬───╖╤═══╕   │
+│ ____ █      ∙     █  █  █   ║---│---║╧╤══╧╤  │
+││oV2o│█             ▀▀▀▀▀    ║---│---║╒╧══╤╧  │
+│╘════╛ █▄▄▄▄▄▄▄▄▄▄▄▄█        ╙───┴───╜╘═══╧   │
+└───────────────────────────Hit ctrl+c to exit─┘
+```
+
+The top of the viewport contains various information about your relay. More specifically:
+
+- The relay nickname as defined in your Tor configuration
+- The uptime since the Tor daemon has started
+- The number of connections
+  - NEW: We have received a new incoming OR connection, and are starting the server-side handshake.
+  - LAUNCHED: We have launched a new outgoing OR connection, and are starting the client-side handshake.
+  - CONNECTED: The OR connection has been connected and the handshake is done.
+  - FAILED: Our attempt to open the OR connection failed.
+  - CLOSED: The OR connection closed in an unremarkable way.
+- The current, average and total amount of data that was downloaded and uploaded
+- The version of the Tor binary, as well as the recommendation from the consensus (if any)
+- If you are connected locally (localhost or Unix socket), the CPU and memory usage of the Tor daemon
+
+## Biology
+
+Tamagonions are very atuned to a relay's operation. You can know how your relay is going by looking at how Stinky is feeling or behaving.
+
+| Behavior     | Meaning                                                                                                                   |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------- |
+| Asleep       | The relay is "dormant", meaning it has gone idle due to lack of use or some similar reason.                               |
+| Sad          | The relay doesn't have the both the "Valid" and the "Running" flags, or it has the "NoEdConsensus" flag.                  |
+| Confused     | The relay discarded expired statuses and server descriptors to fall below the desired threshold of directory information. |
+| Embarassed   | A directory authority rejected our descriptor.                                                                            |
+| Looking away | The relay's ORPort is unreachable.                                                                                        |
+| Bored        | The relay has the "MiddleOnly" flag.                                                                                      |
+| Glitchy      | The relay doesn't have the "Stable" flag.                                                                                 |
+| Old          | The relay has the "StaleDesc" flag.                                                                                       |
+| Egg          | The relay is bootstrapping.                                                                                               |
+| Slow         | The relay doesn't have the "Fast" flag.                                                                                   |
+
+## Room status check
+
+Stinky's room can get a bit crowded with things it collected along the way. But every thing it collects means something special to it.
+
+| Object or room state | Meaning                                        |
+| -------------------- | ---------------------------------------------- |
+| Light's out          | The relay believes the network is unreachable. |
+| Exit sign            | The relay has the "Exit" flag.                 |
+| Broken exit sign     | The relay has the "BadExit" flag.              |
+| Books                | The relay has the "HSDir" flag.                |
+| Cassette             | The relay has the "V2Dir" flag.                |
+| Shield               | The relay has the "Guard" flag.                |
+
+## You may also like...
+
+- [Testing Tor Network](https://github.com/daxAKAhackerman/testing-tor-network) - CLI tool to setup a testing TOR network with Docker
+- [Tor HashedControlPassword Brute](https://github.com/daxAKAhackerman/tor-hashed-control-password-brute) - C program to execute a dictionary attack against a Tor HashedControlPassword value
+
+---
+
+> This repository contains no AI-generated code and was made with :heart: by [@daxAKAhackerman](https://github.com/daxAKAhackerman/)

tamagonion-0.0.0/README.md

@@ -0,0 +1,114 @@
+# Tamagonion
+
+## Instructions
+
+This is Stinky, it's a Tamagonion and it's running your Tor relay. Tamagonions are cyber creatures that have bravely stepped out of the Tor network to learn what life is like in the clearnet and to help you monitor your relay. It mostly loafs around and browses the Web anonymously, but it's more entertaining to look at than a graph!
+
+```
+             ▌▌
+             ▓▓▀
+         ▄▄▄▀▀▀▀▄▄▄
+        █   ─  ─   █
+       █    ▄  ▄    █
+      █     ▀  ▀     █
+      █      ──      █
+      █              █
+       █▄▄▄▄▄▄▄▄▄▄▄▄█
+```
+
+## Activation
+
+To activate the viewport, use the `tamagonion` command as such:
+
+```bash
+# By default, we will try to connect to the control port at 127.0.0.1:9051
+$ uv run tamagonion
+
+# If you use password authentication, you can supply it with -P or with the TAMAGONION_PASSWORD environment variable
+$ uv run tamagonion -P my_password
+$ TAMAGONION_PASSWORD=my_password uv run tamagonion
+
+# If the port is listening somewhere else, you can specify it with -i and -p
+$ uv run tamagonion -i 192.168.0.10 -p 9999
+
+# If you are connecting using a Unix socket, you can point to it with -s
+$ uv run tamagonion -s /var/run/tor/control
+```
+
+## Status check
+
+```
+┌──────────────────────────────────────────────┐
+│Relay nickname: exitafpwrwmm                  │
+│Uptime: 0d 05h 53m 06s                        │
+│Connections (N/L/Co/F/Cl): 0,0,7,0,0          │
+│Download (Cur/Avg/Tot): 338B / 116B / 2MB     │
+│Upload (Cur/Avg/Tot): 1KB / 152B / 3MB        │
+│Version: 0.4.9.11 (none recommended)          │
+│Process info (CPU/Mem): 0.0%/867MB            │
+│                              ░░░░░░░░        │
+│                             ░╔══════╗░   █▄  │
+│             ▌▌          z   ░║ EXIT ║░ █████ │
+│             ▓▓▀        Z    ░╚══════╝░   █▀  │
+│         ▄▄▄▀▀▀▀▄▄▄   Z       ░░░░░░░░        │
+│        █   ─  ─    ▄▄▄▄▄                     │
+│       █           █  █  █                    │
+│      █    ──  ── █  ▀█▀  █  ╓───┬───╖╤═══╕   │
+│ ____ █      ∙     █  █  █   ║---│---║╧╤══╧╤  │
+││oV2o│█             ▀▀▀▀▀    ║---│---║╒╧══╤╧  │
+│╘════╛ █▄▄▄▄▄▄▄▄▄▄▄▄█        ╙───┴───╜╘═══╧   │
+└───────────────────────────Hit ctrl+c to exit─┘
+```
+
+The top of the viewport contains various information about your relay. More specifically:
+
+- The relay nickname as defined in your Tor configuration
+- The uptime since the Tor daemon has started
+- The number of connections
+  - NEW: We have received a new incoming OR connection, and are starting the server-side handshake.
+  - LAUNCHED: We have launched a new outgoing OR connection, and are starting the client-side handshake.
+  - CONNECTED: The OR connection has been connected and the handshake is done.
+  - FAILED: Our attempt to open the OR connection failed.
+  - CLOSED: The OR connection closed in an unremarkable way.
+- The current, average and total amount of data that was downloaded and uploaded
+- The version of the Tor binary, as well as the recommendation from the consensus (if any)
+- If you are connected locally (localhost or Unix socket), the CPU and memory usage of the Tor daemon
+
+## Biology
+
+Tamagonions are very atuned to a relay's operation. You can know how your relay is going by looking at how Stinky is feeling or behaving.
+
+| Behavior     | Meaning                                                                                                                   |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------- |
+| Asleep       | The relay is "dormant", meaning it has gone idle due to lack of use or some similar reason.                               |
+| Sad          | The relay doesn't have the both the "Valid" and the "Running" flags, or it has the "NoEdConsensus" flag.                  |
+| Confused     | The relay discarded expired statuses and server descriptors to fall below the desired threshold of directory information. |
+| Embarassed   | A directory authority rejected our descriptor.                                                                            |
+| Looking away | The relay's ORPort is unreachable.                                                                                        |
+| Bored        | The relay has the "MiddleOnly" flag.                                                                                      |
+| Glitchy      | The relay doesn't have the "Stable" flag.                                                                                 |
+| Old          | The relay has the "StaleDesc" flag.                                                                                       |
+| Egg          | The relay is bootstrapping.                                                                                               |
+| Slow         | The relay doesn't have the "Fast" flag.                                                                                   |
+
+## Room status check
+
+Stinky's room can get a bit crowded with things it collected along the way. But every thing it collects means something special to it.
+
+| Object or room state | Meaning                                        |
+| -------------------- | ---------------------------------------------- |
+| Light's out          | The relay believes the network is unreachable. |
+| Exit sign            | The relay has the "Exit" flag.                 |
+| Broken exit sign     | The relay has the "BadExit" flag.              |
+| Books                | The relay has the "HSDir" flag.                |
+| Cassette             | The relay has the "V2Dir" flag.                |
+| Shield               | The relay has the "Guard" flag.                |
+
+## You may also like...
+
+- [Testing Tor Network](https://github.com/daxAKAhackerman/testing-tor-network) - CLI tool to setup a testing TOR network with Docker
+- [Tor HashedControlPassword Brute](https://github.com/daxAKAhackerman/tor-hashed-control-password-brute) - C program to execute a dictionary attack against a Tor HashedControlPassword value
+
+---
+
+> This repository contains no AI-generated code and was made with :heart: by [@daxAKAhackerman](https://github.com/daxAKAhackerman/)

tamagonion-0.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "tamagonion"
+version = "0.0.0"
+description = "This is Stinky, he's running your Tor relay. He mostly loafs around and browses the Web anonymously, but he's more entertaining to look at than a graph!"
+readme = "README.md"
+requires-python = "==3.14.*"
+dependencies = [
+    "psutil==7.2.2",
+    "stem==1.8.2",
+]
+
+[[project.authors]]
+name = "Samuel De Grace"
+email = "48831884+daxAKAhackerman@users.noreply.github.com"
+
+[project.scripts]
+tamagonion = "tamagonion:main"
+
+[build-system]
+requires = ["uv_build==0.12.3"]
+build-backend = "uv_build"

tamagonion-0.0.0/pyproject.toml.orig

@@ -0,0 +1,20 @@
+[project]
+name = "tamagonion"
+version = "0.0.0"
+description = "This is Stinky, he's running your Tor relay. He mostly loafs around and browses the Web anonymously, but he's more entertaining to look at than a graph!"
+readme = "README.md"
+authors = [
+    { name = "Samuel De Grace", email = "48831884+daxAKAhackerman@users.noreply.github.com" }
+]
+requires-python = "==3.14.*"
+dependencies = [
+    "psutil==7.2.2",
+    "stem==1.8.2",
+]
+
+[project.scripts]
+tamagonion = "tamagonion:main"
+
+[build-system]
+requires = ["uv_build==0.12.3"]
+build-backend = "uv_build"

tamagonion-0.0.0/src/tamagonion/__init__.py

@@ -0,0 +1,48 @@
+import argparse
+import sys
+from time import sleep
+
+from tamagonion.app_data import AppData
+from tamagonion.draw import Paper
+from tamagonion.relay_manager import RelayManager
+
+
+def main() -> None:
+    args = get_args()
+
+    print("\033[2J\033[H", end="")  # Clear the screen and reset cursor
+    relay_manager = RelayManager(ip_addr=args.ip, port=args.port, password=args.password, socket_file=args.socket_file)
+    app_data = AppData(relay_manager)
+    paper = Paper(app_data)
+
+    try:
+        while True:
+            app_data.update()
+            paper.draw()
+            sleep(1)
+    except KeyboardInterrupt:
+        pass
+
+    paper.erase(include_frame=True)
+    sys.exit(0)
+
+
+def get_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        prog="Tamagonion",
+        description="This is Stinky, he's running your Tor relay. He mostly loafs around and browses the Web anonymously, but he's more entertaining to look at than a graph!",
+        epilog="Hack the planet!",
+    )
+
+    parser.add_argument(
+        "-i", "--ip", help="IP of the Tor relay where the control protocol listens. Can also be a hostname. Defaults to 127.0.0.1.", default="127.0.0.1"
+    )
+    parser.add_argument("-p", "--port", help="Control port. Defaults to 9051.", default="9051")
+    parser.add_argument("-P", "--password", help="Control port password, if any", required=False)
+    parser.add_argument("-s", "--socket-file", help="Path to the socket file to use instead of an IP", required=False)
+
+    return parser.parse_args()
+
+
+if __name__ == "__main__":
+    main()

tamagonion-0.0.0/src/tamagonion/app_data.py

@@ -0,0 +1,152 @@
+from collections import defaultdict
+from enum import StrEnum
+from typing import Any, Self
+
+import psutil
+from stem import DescriptorUnavailable
+from stem.version import Version
+
+from tamagonion.relay_manager import RelayManager
+
+SECONDS_IN_MINUTE = 60
+SECONDS_IN_HOUR = SECONDS_IN_MINUTE * 60
+SECONDS_IN_DAY = SECONDS_IN_HOUR * 24
+
+
+class Flags(StrEnum):
+    BAD_EXIT = "BadExit"
+    EXIT = "Exit"
+    FAST = "Fast"
+    GUARD = "Guard"
+    HS_DIR = "HSDir"
+    MIDDLE_ONLY = "MiddleOnly"
+    STABLE = "Stable"
+    STALE_DESC = "StaleDesc"
+    V2_DIR = "V2Dir"
+    NO_ED_CONSENSUS = "NoEdConsensus"
+    RUNNING = "Running"
+    VALID = "Valid"
+
+
+class AppData:
+    relay_manager: RelayManager
+    flags: list[str]
+    version: Version
+    info: dict[str, Any]
+    process_info: dict[str, Any]
+    uptime: float = 0.0
+    connection_status_map: defaultdict[str, int]
+    pid: int = 0
+    version_status: str = ""
+    relay_name: str = ""
+    frame: int = 0
+    frame_skip: bool = False
+    instance: Self | None = None
+
+    def __init(self, relay_manager: RelayManager) -> None:
+        self.process_info = {}
+        self.info = {}
+        self.version = Version("0.0.0.0")
+        self.flags = []
+        self.connection_status_map = defaultdict(lambda: 0)
+
+        self.relay_manager = relay_manager
+        self._get_version()
+        self._get_version_status()
+        self._get_pid()
+        self._get_relay_name()
+
+    def __new__(cls, *args, **kwargs) -> Self:
+        if cls.instance is None:
+            cls.instance = super().__new__(cls)
+            cls.instance.__init(*args, **kwargs)
+        return cls.instance
+
+    def update(self) -> None:
+        self._get_flags()
+        self._get_uptime()
+        self._get_info()
+        self._get_orconn_status()
+
+        if self.relay_manager.is_local:
+            self._get_process_info()
+
+    def _get_flags(self) -> None:
+        try:
+            self.flags = self.relay_manager.controller.get_network_status().flags
+        except DescriptorUnavailable:
+            self.flags = []
+
+    def _get_uptime(self) -> None:
+        self.uptime = self.relay_manager.controller.get_uptime()
+
+    @property
+    def formated_uptime(self) -> str:
+        uptime_as_int = int(self.uptime)
+        days = uptime_as_int // SECONDS_IN_DAY
+        hours = (uptime_as_int % SECONDS_IN_DAY) // SECONDS_IN_HOUR
+        minutes = (uptime_as_int % SECONDS_IN_HOUR) // SECONDS_IN_MINUTE
+        seconds = uptime_as_int % SECONDS_IN_MINUTE
+
+        return f"{days}d {hours:02}h {minutes:02}m {seconds:02}s"
+
+    def _get_pid(self) -> None:
+        self.pid = self.relay_manager.controller.get_pid()
+
+    def _get_version(self) -> None:
+        self.version = self.relay_manager.controller.get_version()
+
+    def _get_version_status(self) -> None:
+        self.version_status = self.relay_manager.controller.get_info("status/version/current")
+
+    def _get_relay_name(self) -> None:
+        nickname = self.relay_manager.controller.get_conf("Nickname")
+        self.relay_name = nickname or "Unknown"
+
+    def _get_info(self) -> None:
+        bw_event_cache = self.relay_manager.controller.get_info("bw-event-cache")
+        bw_event_latest = bw_event_cache.split(" ")[-1].split(",")
+        traffic_read = self.relay_manager.controller.get_info("traffic/read")
+        traffic_written = self.relay_manager.controller.get_info("traffic/written")
+
+        self.info = {
+            "dormant": self.relay_manager.controller.get_info("dormant") != "0",
+            "traffic_read": int(traffic_read),
+            "traffic_written": int(traffic_written),
+            "bw_event_cache_down": int(bw_event_latest[0]),
+            "bw_event_cache_up": int(bw_event_latest[1]),
+            "bw_avg_down": int(traffic_read) / self.uptime,
+            "bw_avg_up": int(traffic_written) / self.uptime,
+            "network_liveness": self.relay_manager.controller.get_info("network-liveness") == "up",
+            "bootstrap_percent": int(self.relay_manager.controller.get_info("status/bootstrap-phase").split(" ")[2].split("=")[-1]),
+            "has_enough_dir_info": self.relay_manager.controller.get_info("status/enough-dir-info") == "1",
+            "good_server_descriptor": self.relay_manager.controller.get_info("status/good-server-descriptor") == "1",
+            "reachability": self.relay_manager.controller.get_info("status/reachability-succeeded/or") == "1",
+        }
+
+    def _get_orconn_status(self) -> None:
+        self.connection_status_map = defaultdict(lambda: 0)
+        orconn_status = self.relay_manager.controller.get_info("orconn-status")
+
+        for status in orconn_status.split("\n"):
+            _node, state = status.split(" ")
+            self.connection_status_map[state] += 1
+
+    def _get_process_info(self) -> None:
+        process = psutil.Process(self.pid)
+
+        self.process_info = {
+            "cpu": process.cpu_percent(),
+            "memory": process.memory_info().rss,
+        }
+
+    @staticmethod
+    def format_bytes(b: int) -> str:
+        if b < 10**3:
+            return f"{int(b)}B"
+        elif b < 10**6:
+            return f"{int(b / (10**3))}KB"
+        elif b < 10**9:
+            return f"{int(b / (10**6))}MB"
+        else:
+            return f"{int(b / (10**9))}GB"

tamagonion-0.0.0/src/tamagonion/art.py

@@ -0,0 +1,276 @@
+frame = """┌──────────────────────────────────────────────┐
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+│                                              │
+└───────────────────────────Hit ctrl+c to exit─┘"""
+
+stinky_base = [
+    """│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ─  ─   █
+│       █    ▄  ▄    █
+│      █     ▀  ▀     █
+│      █      ──      █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ─  ─   █
+│       █    ▄  ▄    █
+│      █     ▀  ▀     █
+│      █      ──      █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_asleep = [
+    """│             ▌▌          z
+│             ▓▓▀        Z
+│         ▄▄▄▀▀▀▀▄▄▄   Z
+│        █   ─  ─   █
+│       █            █
+│      █    ──  ──    █
+│      █      ∙       █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█""",
+    """│
+│             ▌▌          z
+│             ▓▓▀        Z
+│         ▄▄▄▀▀▀▀▄▄▄   Z
+│        █   ─  ─   █
+│       █            █
+│      █    ──  ──    █
+│      █      ∙       █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_blackout = [
+    """│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+│░▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒░
+│░▒▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓█████████▀██▀███████████████████████████▓▒░
+│░▒▓█████████▄██▄███████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░""",
+    """│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+│░▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒░
+│░▒▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓█████████▀██▀███████████████████████████▓▒░
+│░▒▓█████████▄██▄███████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░
+│░▒▓████████████████████████████████████████▓▒░""",
+]
+
+stinky_sad = [
+    """│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   /  \\   █
+│       █    ▄  ▄    █
+│      █    °▀  ▀°    █
+│      █    ° ──      █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   /  \\   █
+│       █    ▄  ▄    █
+│      █    °▀  ▀°    █
+│      █    ° ──      █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_confused = [
+    """│             ▌▌       ?
+│             ▓▓▀        ?
+│         ▄▄▄▀▀▀▀▄▄▄   ?
+│        █   ─  ^   █
+│       █    ▄  ▄    █
+│      █     ▀  ▀     █
+│      █     ───      █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█    """,
+    """│
+│             ▌▌       ?
+│             ▓▓▀        ?
+│         ▄▄▄▀▀▀▀▄▄▄   ?
+│        █   ─  ^   █
+│       █    ▄  ▄    █
+│      █     ▀  ▀     █
+│      █     ───      █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█    """,
+]
+
+stinky_embarassed = [
+    """│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   /  \\   █
+│       █          ° █
+│      █     ^  ^     █
+│      █   O  ──  O   █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   /  \\   █
+│       █          ° █
+│      █     ^  ^     █
+│      █   O  ──  O   █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_turned_around = [
+    """│             ▐▐
+│            ▀▓▓
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █          █
+│       █            █
+│      █              █
+│      █              █
+│      █    (_)(_)    █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ▐▐
+│            ▀▓▓
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █          █
+│       █            █
+│      █              █
+│      █              █
+│      █▄▄▄▄(_)(_)▄▄▄▄█""",
+]
+stinky_bored = [
+    """│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ^  ^   █
+│       █   ──  ──   █
+│      █      __      █
+│      █     (__)     █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ▌▌
+│             ▓▓▀
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ^  ^   █
+│       █   ──  ──   █
+│      █      __      █
+│      █     (__)     █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_unstable = [
+    """│             ▌▌
+│             ▓▓▀
+│      ░░░▄▄▄▀▀▀▀▄▄▄
+│        █   ─ ────── ──
+│    ───█─  ─▄ ─▄    █
+│     ▓▓▓▓   ▀  ▀─ ─  █
+│      ──     ──    ▒▒▒▒
+│      █       ─ ─ ─ ─█ ─ ──
+│      ░░░░░░▄▄▄▄▄▄▄▄█      """,
+    """│
+│             ▌▌
+│             ▓▓▀
+│         ▄░░░▀▀▀▄▄▄
+│        █  ── ──   █
+│       █ ░──▄  ▄ ───█
+│      ░░░   ▀  ▀    ▓▓
+│     ── ── ─ ───     █
+│      █▄▄▄▄▄▄▄▄▒▒▒▄▒▄▒▒""",
+]
+
+stinky_old = [
+    """│             ││
+│             ▓▓-
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ─  ─   █
+│       █            █
+│      █    =▀  ▀=    █
+│      █    ( ── )    █
+│      █              █
+│       █▄▄▄▄▄▄▄▄▄▄▄▄█ """,
+    """│
+│             ││
+│             ▓▓-
+│         ▄▄▄▀▀▀▀▄▄▄
+│        █   ─  ─   █
+│       █            █
+│      █    =▀  ▀=    █
+│      █    ( ── )    █
+│      █▄▄▄▄▄▄▄▄▄▄▄▄▄▄█""",
+]
+
+stinky_egg = """│            ▄▀▀▄
+│          ▄█    ▀▄
+│        ▄▀ █    ███▄
+│       ▄▀ █ █   ████▄
+│      █  ▀   █   ███▀█
+│     ██     ▀ ▀      ██
+│     █████▄    ▄██▄  ██
+│     ██████    ▀██▀  ██
+│      ▀███▄▄▄▄▄▄▄▄▄▄█▀ """
+
+
+exit_sign = """ ░░░░░░░░
+░╔══════╗░   █▄
+░║ EXIT ║░ █████
+░╚══════╝░   █▀
+ ░░░░░░░░       """
+
+
+broken_exit_sign = """ ══════╗    ▓▄
+║ EX_T ║  ░▒▓██
+╚════ ═╝    ▓▀ """
+
+book = """╓───┬───╖╤═══╕
+║---│---║╧╤══╧╤
+║---│---║╒╧══╤╧
+╙───┴───╜╘═══╧ """
+
+cassette = """ ____
+│oV2o│
+╘════╛"""
+
+shield = [
+    """  ▄▄▄▄▄
+ █  █  █
+█  ▀█▀  █
+ █  █  █
+  ▀▀▀▀▀  """,
+    """
+  ▄▄▄▄▄
+ █  █  █
+█  ▀█▀  █
+ █  █  █
+  ▀▀▀▀▀  """,
+]

tamagonion-0.0.0/src/tamagonion/draw.py

@@ -0,0 +1,140 @@
+from typing import Self
+
+from tamagonion import art
+from tamagonion.app_data import AppData, Flags
+
+
+class Pen:
+    @staticmethod
+    def draw(image: str, pos_y: int, pos_x: int, transparent: bool = False) -> None:
+        if transparent:
+            image.replace(" ", "\033C")
+        move_x = f"\033[{pos_x}C" if pos_x > 0 else ""
+        move_y = f"\033[{pos_y}B" if pos_y > 0 else ""
+
+        print("\033[s", end="")
+        print(f"{move_x}{move_y}", end="")
+        for line in image.split("\n"):
+            print(line, end="")
+            print(f"\r{move_x}\033[B", end="")
+        print("\033[u", end="")
+
+
+class Paper:
+    app_data: AppData
+    instance: Self | None = None
+
+    def __init(self, app_data: AppData) -> None:
+        self.app_data = app_data
+
+    def __new__(cls, *args, **kwargs) -> Self:
+        if cls.instance is None:
+            cls.instance = super().__new__(cls)
+            cls.instance.__init(*args, **kwargs)
+        return cls.instance
+
+    def draw(self) -> None:
+        self.erase()
+
+        ## Draw the frame
+        Pen.draw(art.frame, 0, 0)
+
+        ## Draw Stinky
+
+        # Bootstrap statuses
+        if self.app_data.info["bootstrap_percent"] < 100:
+            Pen.draw(art.stinky_egg, 10, 0)
+
+        # Network statuses
+        elif not self.app_data.info["network_liveness"]:
+            Pen.draw(art.stinky_blackout[self.app_data.frame], 9, 0)
+        elif not self.app_data.info["has_enough_dir_info"]:
+            Pen.draw(art.stinky_confused[self.app_data.frame], 10, 0)
+
+        # Relay network statuses
+        elif not self.app_data.info["reachability"]:
+            Pen.draw(art.stinky_turned_around[self.app_data.frame], 10, 0)
+        elif not self.app_data.info["good_server_descriptor"]:
+            Pen.draw(art.stinky_embarassed[self.app_data.frame], 10, 0)
+
+        # Relay statuses
+        elif Flags.NO_ED_CONSENSUS in self.app_data.flags or {Flags.VALID, Flags.RUNNING} - set(self.app_data.flags):
+            Pen.draw(art.stinky_sad[self.app_data.frame], 10, 0)
+        elif Flags.STALE_DESC in self.app_data.flags:
+            Pen.draw(art.stinky_old[self.app_data.frame], 10, 0)
+        elif Flags.STABLE not in self.app_data.flags:
+            Pen.draw(art.stinky_unstable[self.app_data.frame], 10, 0)
+        elif Flags.MIDDLE_ONLY in self.app_data.flags:
+            Pen.draw(art.stinky_bored[self.app_data.frame], 10, 0)
+        elif self.app_data.info["dormant"]:
+            Pen.draw(art.stinky_asleep[self.app_data.frame], 10, 0)
+        else:
+            Pen.draw(art.stinky_base[self.app_data.frame], 10, 0)
+
+        ## Draw the exit sign
+
+        if Flags.BAD_EXIT in self.app_data.flags:
+            Pen.draw(art.broken_exit_sign, 9, 31)
+        elif Flags.EXIT in self.app_data.flags:
+            Pen.draw(art.exit_sign, 8, 30)
+
+        ## Draw the books
+
+        if Flags.HS_DIR in self.app_data.flags:
+            Pen.draw(art.book, 15, 30)
+
+        ## Draw the cassette
+
+        if Flags.V2_DIR in self.app_data.flags:
+            Pen.draw(art.cassette, 16, 1)
+
+        ## Draw the shield
+
+        if Flags.GUARD in self.app_data.flags and self.app_data.info["reachability"]:
+            Pen.draw(art.shield[self.app_data.frame], 13, 19)
+
+        ## Slow down the animation
+
+        if Flags.FAST not in self.app_data.flags and self.app_data.frame_skip:
+            self.app_data.frame_skip = False
+        else:
+            self.app_data.frame ^= 1
+            self.app_data.frame_skip = True
+
+        ## Draw the stats
+
+        Pen.draw(f"Relay nickname: {self.app_data.relay_name}", 1, 1)
+        Pen.draw(f"Uptime: {self.app_data.formated_uptime}", 2, 1)
+        Pen.draw(
+            f"Connections (N/L/Co/F/Cl): {self.app_data.connection_status_map['NEW']}/{self.app_data.connection_status_map['LAUNCHED']}/{self.app_data.connection_status_map['CONNECTED']}/{self.app_data.connection_status_map['FAILED']}/{self.app_data.connection_status_map['CLOSED']}",
+            3,
+            1,
+        )
+        Pen.draw(
+            f"Download (Cur/Avg/Tot): {AppData.format_bytes(self.app_data.info['bw_event_cache_down'])} / {AppData.format_bytes(self.app_data.info['bw_avg_down'])} / {AppData.format_bytes(self.app_data.info['traffic_read'])}",
+            4,
+            1,
+        )
+        Pen.draw(
+            f"Upload (Cur/Avg/Tot): {AppData.format_bytes(self.app_data.info['bw_event_cache_up'])} / {AppData.format_bytes(self.app_data.info['bw_avg_up'])} / {AppData.format_bytes(self.app_data.info['traffic_written'])}",
+            5,
+            1,
+        )
+        Pen.draw(f"Version: {self.app_data.version} ({self.app_data.version_status})", 6, 1)
+
+        if self.app_data.relay_manager.is_local:
+            Pen.draw(
+                f"Process info (CPU/Mem): {self.app_data.process_info['cpu']}% / {AppData.format_bytes(self.app_data.process_info['memory'])}",
+                7,
+                1,
+            )
+
+    def erase(self, include_frame: bool = False) -> None:
+        if include_frame:
+            print("\033[0J", end="")
+        else:
+            split_frame = art.frame.split("\n")
+            frame_height = len(split_frame)
+            frame_witdh = len(split_frame[0])
+            for i in range(1, frame_height - 1):
+                Pen.draw(" " * (frame_witdh - 2), i, 1)

tamagonion-0.0.0/src/tamagonion/relay_manager.py

@@ -0,0 +1,33 @@
+import os
+from typing import Self
+
+from stem.control import Controller, EventType
+
+
+class RelayManager:
+    controller: Controller
+    is_local: bool = False
+    instance: Self | None = None
+
+    def __init(self, ip_addr: str, port: str, password: str | None, socket_file: str | None) -> None:
+        if socket_file:
+            self.controller = Controller.from_socket_file(socket_file)
+        else:
+            self.controller = Controller.from_port(address=ip_addr, port=int(port))  # type:ignore
+        if password:
+            self.controller.authenticate("password")
+        elif env_password := os.getenv("TAMAGONION_PASSWORD"):
+            self.controller.authenticate(env_password)
+        else:
+            self.controller.authenticate()
+
+        if socket_file or self.controller.is_localhost():
+            self.is_local = True
+
+        self.controller.add_event_listener(lambda: True, EventType["BW"])
+
+    def __new__(cls, *args, **kwargs) -> Self:
+        if cls.instance is None:
+            cls.instance = super().__new__(cls)
+            cls.instance.__init(*args, **kwargs)
+        return cls.instance