lupaxa-chat-client 0.1.0__tar.gz

lupaxa_chat_client-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# OS
+.DS_Store
+
+# Cursor
+.cursor/
+.superpowers/
+.worktrees/
+cursor-docs
+
+# Make
+.makefiles/
+
+# MkDocs
+site/
+
+# Python
+.venv/
+__pycache__/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/
+*.egg-info/

lupaxa_chat_client-0.1.0/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) The Lupaxa Project
+
+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.

lupaxa_chat_client-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.5
+Name: lupaxa-chat-client
+Version: 0.1.0
+Summary: A terminal client for the chat server, keeping server text separate from what you are typing.
+Project-URL: Homepage, https://github.com/lupaxa-after-hours/chat-client
+Project-URL: Repository, https://github.com/lupaxa-after-hours/chat-client
+Project-URL: Issues, https://github.com/lupaxa-after-hours/chat-client/issues
+Author: The Lupaxa Project
+License: MIT License
+        
+        Copyright (c) The Lupaxa Project
+        
+        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.
+License-File: LICENCE
+Keywords: chat,client,terminal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.10
+Requires-Dist: asyncssh>=2.14
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
+Requires-Dist: hatch>=1.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.12.0; extra == 'dev'
+Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://github.com/lupaxa-after-hours">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="After Hours" />
+  </a>
+</p>
+
+<h1 align="center">Chat Client</h1>
+
+A terminal client for the [chat server](https://github.com/lupaxa-after-hours/chat-server).
+Text from the server stays in the upper part of the screen. The line you are
+typing stays at the bottom, and new text does not clear it.
+
+The bottom line is the prompt the server just sent: the name prompt, a
+password prompt, or the player's own prompt. The two lines above it are the
+last two lines you sent, still showing the prompt that was in use then. A
+bar separates that area from the history. The server's prompt is not copied
+into the history.
+
+## Install
+
+```bash
+pip install lupaxa-chat-client
+```
+
+Requires Python 3.10+.
+
+> **Note:** `chat-client` only runs in a terminal. It stops before connecting
+> when standard input or standard output is not a terminal.
+
+## Run
+
+The host and the port are required. Use the port the server is listening on.
+
+```bash
+chat-client telnet 127.0.0.1 9000
+chat-client ssh 127.0.0.1 9022
+```
+
+Telnet and SSH both show the server's normal text. On telnet the line is
+edited locally and sent when you press Enter. On SSH each character is sent
+as you type, and the server echoes it onto the prompt. SSH signs in as the
+user `chat`.
+
+The first SSH host key is saved in `~/.chat-client/known_hosts`. A key that
+no longer matches is refused.
+
+## The Screen
+
+Server lines wrap to the width of the terminal. Narrowing or widening the
+window wraps them again from the original lines. Page Up keeps the same rows
+on screen while more text arrives. End, or Page Down back to the bottom,
+shows the newest lines.
+
+A password prompt hides the characters you type. Ctrl-C leaves and restores
+the terminal.
+
+## Keys
+
+Scrolling and editing stay on this client. They are not sent to the server.
+
+| Key            | What it Does                                    |
+| -------------- | ----------------------------------------------- |
+| Page Up        | Scroll the history up by one screen.            |
+| Page Down      | Scroll the history down by one screen.          |
+| End            | Jump back to the newest server lines.           |
+| Left and Right | Move the cursor along the line you are typing.  |
+| Backspace      | Delete the character before the cursor.         |
+| Delete         | Delete the character at the cursor.             |
+| Enter          | Send the line.                                  |
+| Ctrl-C         | Leave and restore the terminal.                 |
+
+Up and Down do not recall earlier lines. Ctrl-D does not quit.
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_client-0.1.0/README.md

@@ -0,0 +1,76 @@
+<p align="center">
+  <a href="https://github.com/lupaxa-after-hours">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="After Hours" />
+  </a>
+</p>
+
+<h1 align="center">Chat Client</h1>
+
+A terminal client for the [chat server](https://github.com/lupaxa-after-hours/chat-server).
+Text from the server stays in the upper part of the screen. The line you are
+typing stays at the bottom, and new text does not clear it.
+
+The bottom line is the prompt the server just sent: the name prompt, a
+password prompt, or the player's own prompt. The two lines above it are the
+last two lines you sent, still showing the prompt that was in use then. A
+bar separates that area from the history. The server's prompt is not copied
+into the history.
+
+## Install
+
+```bash
+pip install lupaxa-chat-client
+```
+
+Requires Python 3.10+.
+
+> **Note:** `chat-client` only runs in a terminal. It stops before connecting
+> when standard input or standard output is not a terminal.
+
+## Run
+
+The host and the port are required. Use the port the server is listening on.
+
+```bash
+chat-client telnet 127.0.0.1 9000
+chat-client ssh 127.0.0.1 9022
+```
+
+Telnet and SSH both show the server's normal text. On telnet the line is
+edited locally and sent when you press Enter. On SSH each character is sent
+as you type, and the server echoes it onto the prompt. SSH signs in as the
+user `chat`.
+
+The first SSH host key is saved in `~/.chat-client/known_hosts`. A key that
+no longer matches is refused.
+
+## The Screen
+
+Server lines wrap to the width of the terminal. Narrowing or widening the
+window wraps them again from the original lines. Page Up keeps the same rows
+on screen while more text arrives. End, or Page Down back to the bottom,
+shows the newest lines.
+
+A password prompt hides the characters you type. Ctrl-C leaves and restores
+the terminal.
+
+## Keys
+
+Scrolling and editing stay on this client. They are not sent to the server.
+
+| Key            | What it Does                                    |
+| -------------- | ----------------------------------------------- |
+| Page Up        | Scroll the history up by one screen.            |
+| Page Down      | Scroll the history down by one screen.          |
+| End            | Jump back to the newest server lines.           |
+| Left and Right | Move the cursor along the line you are typing.  |
+| Backspace      | Delete the character before the cursor.         |
+| Delete         | Delete the character at the cursor.             |
+| Enter          | Send the line.                                  |
+| Ctrl-C         | Leave and restore the terminal.                 |
+
+Up and Down do not recall earlier lines. Ctrl-D does not quit.
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_client-0.1.0/docs/README.md

@@ -0,0 +1,23 @@
+<p align="center">
+    <a href="https://github.com/lupaxa-after-hours">
+        <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="Organisation Logo" />
+    </a>
+</p>
+
+<h1 align="center">Core Documentation</h1>
+
+The following documents define the standards that apply across **The Lupaxa Project**:
+
+| Document                              | Purpose                                                           |
+| :------------------------------------ | :---------------------------------------------------------------- |
+| [Code of Conduct](CODE_OF_CONDUCT.md) | Expected behaviour and reporting procedures.                      |
+| [How to Contribute](CONTRIBUTING.md)  | Development workflow, coding standards, and contribution process. |
+| [Governance](GOVERNANCE.md)           | Project governance, roles, and decision-making.                   |
+| [Maintainers](MAINTAINERS.md)         | Maintainer responsibilities and expectations.                     |
+| [Projects Overview](PROJECTS.md)      | Overview of organisations, repositories, and project structure.   |
+| [Security Policy](SECURITY.md)        | Responsible disclosure and secure development practices.          |
+| [Support Guide](SUPPORT.md)           | How to obtain help and support.                                   |
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_client-0.1.0/pyproject.toml

@@ -0,0 +1,107 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lupaxa-chat-client"
+dynamic = ["version"]
+description = "A terminal client for the chat server, keeping server text separate from what you are typing."
+readme = "README.md"
+license = { file = "LICENCE" }
+requires-python = ">=3.10"
+authors = [
+  { name = "The Lupaxa Project" }
+]
+keywords = ["chat", "client", "terminal"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Communications :: Chat",
+]
+dependencies = [
+  "asyncssh>=2.14",
+]
+
+[project.scripts]
+chat-client = "lupaxa.chat_client.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/lupaxa-after-hours/chat-client"
+Repository = "https://github.com/lupaxa-after-hours/chat-client"
+Issues = "https://github.com/lupaxa-after-hours/chat-client/issues"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+  "ruff>=0.6.0",
+  "mypy>=1.12.0",
+  "hatch>=1.12.0",
+  "bump-my-version>=1.2.0",
+  "pip-audit>=2.7.0",
+]
+test = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+]
+
+[tool.hatch.version]
+path = "src/lupaxa/chat_client/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/**",
+  "README.md",
+  "LICENCE",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lupaxa"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "S", "UP", "SIM", "C4", "ISC", "D", "ANN", "PT"]
+ignore = [
+  "D200", "D201", "D202", "D203", "D204", "D205", "D206", "D207",
+  "D208", "D209", "D210", "D211", "D212",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101", "ANN001", "ANN201"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.pyright]
+typeCheckingMode = "standard"
+enableTypeIgnoreComments = true
+pythonVersion = "3.10"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+mypy_path = "src"
+explicit_package_bases = true
+namespace_packages = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = "-ra -q --disable-warnings"
+testpaths = ["tests"]
+pythonpath = ["src"]

lupaxa_chat_client-0.1.0/src/lupaxa/chat_client/__init__.py

@@ -0,0 +1,7 @@
+"""Terminal client for the chat server."""
+
+from __future__ import annotations
+
+from .version import __version__, get_version
+
+__all__ = ["__version__", "get_version"]

lupaxa_chat_client-0.1.0/src/lupaxa/chat_client/app.py

@@ -0,0 +1,99 @@
+"""Connect server bytes and keys to the screen."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+
+from .ssh import EchoStripper
+from .telnet import TelnetParser
+from .terminal import Screen
+
+Transport = TelnetParser | EchoStripper
+
+
+class App:
+    """One session. Exit always restores the terminal once."""
+
+    def __init__(self, screen: Screen, transport: Transport, restore: Callable[[], None]) -> None:
+        """Keep the screen, the transport, and the restore callback."""
+        self.screen = screen
+        self._transport = transport
+        self._restore = restore
+        self.outgoing: list[bytes] = []
+        self.exited = False
+        self.restored = False
+
+    def server_data(self, data: bytes) -> None:
+        """Append visible server text and apply echo or the hidden flag."""
+        text = self._transport.feed(data)
+        self.screen.set_hidden(self._transport.hidden)
+        if isinstance(self._transport, EchoStripper):
+            echoed = self._transport.take_echo()
+            if echoed:
+                self.screen.echo(echoed)
+        if text:
+            self.screen.add_server_text(text)
+
+    def seal_prompt(self) -> None:
+        """Drop the idle server prompt from the next line of history."""
+        self.screen.seal_prompt()
+
+    def key(self, name: str) -> None:
+        """Edit, send, or quit. Ctrl-C restores and adds no failure line."""
+        if self.exited:
+            return
+        if name == "ctrl-c":
+            self._exit()
+            return
+        if name == "ctrl-d":
+            return
+        if isinstance(self._transport, TelnetParser):
+            if name == "enter":
+                line = self.screen.key(name)
+                self.outgoing.append(self._transport.send_line(line or ""))
+                return
+            data = self._transport.send_key(name)
+            if data:
+                self.outgoing.append(data)
+            self.screen.key(name)
+            return
+        if name in {"pageup", "pagedown", "end", "left", "right", "up", "down"}:
+            self.screen.key(name)
+            return
+        if name == "backspace":
+            self.outgoing.append(self._transport.send_erase())
+            return
+        if name == "delete":
+            if self.screen.cursor_at_end():
+                self.outgoing.append(self._transport.send_erase())
+            else:
+                self.screen.key("delete")
+            return
+        if name == "enter":
+            self.screen.key(name)
+            enter = self._transport.send_enter()
+            if enter:
+                self.outgoing.append(enter)
+            return
+        data = self._transport.send_key(name)
+        if data:
+            self.outgoing.append(data)
+
+    def fail(self, message: str) -> None:
+        """Show ``message`` above the bar, then restore and exit."""
+        if self.exited:
+            return
+        self.screen.add_server_text(message + "\n")
+        self._exit()
+
+    def resize(self, columns: int, rows: int) -> None:
+        """Resize the screen and send the telnet window size when that transport is in use."""
+        self.screen.resize(columns, rows)
+        if isinstance(self._transport, TelnetParser):
+            self.outgoing.append(self._transport.window_size(columns, rows))
+
+    def _exit(self) -> None:
+        if not self.restored:
+            self._restore()
+            self.restored = True
+        self.exited = True

lupaxa_chat_client-0.1.0/src/lupaxa/chat_client/cli.py

@@ -0,0 +1,26 @@
+"""Command line for telnet and SSH."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from collections.abc import Callable
+
+
+def main(argv: list[str] | None = None, run: Callable[[str, str, int], int] | None = None) -> int:
+    """Parse the command. Return 1 when stdin or stdout is not a terminal."""
+    parser = argparse.ArgumentParser(prog="chat-client")
+    commands = parser.add_subparsers(dest="command", required=True)
+    for name in ("telnet", "ssh"):
+        sub = commands.add_parser(name)
+        sub.add_argument("host")
+        sub.add_argument("port", type=int)
+    args = parser.parse_args(argv)
+    if not sys.stdin.isatty() or not sys.stdout.isatty():
+        print("chat-client needs a terminal.", file=sys.stderr)
+        return 1
+    if run is None:
+        from .session import run_client
+
+        return run_client(str(args.command), str(args.host), int(args.port))
+    return run(str(args.command), str(args.host), int(args.port))