typefaster-cli 0.1.4__tar.gz → 0.2.0__tar.gz

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/.gitignore

@@ -30,3 +30,4 @@ typefaster.db*
 .vscode/
 .DS_Store
 .env
+docs/MARKETING.md

typefaster_cli-0.2.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: typefaster-cli
+Version: 0.2.0
+Summary: A terminal-first typing game inspired by MonkeyType and TypeRacer.
+Project-URL: Homepage, https://github.com/Anoshor/typefaster-cli
+Project-URL: Repository, https://github.com/Anoshor/typefaster-cli
+Author: Anoshor Paul
+License: MIT
+License-File: LICENSE
+Keywords: cli,game,monkeytype,terminal,tui,typeracer,typing,wpm
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: rich>=13.7
+Requires-Dist: textual>=0.60
+Requires-Dist: typer>=0.12
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: textual-dev>=1.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ⌨ TYPEFASTER
+
+[![CI](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/typefaster-cli)](https://pypi.org/project/typefaster-cli/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+A **terminal-first** typing game inspired by MonkeyType and TypeRacer — race
+quotes, beat your ghost, climb leaderboards, and play **live multiplayer** with
+friends. Pure TUI, no browser, no GUI.
+
+```bash
+brew install Anoshor/typefaster/typefaster   # or: pipx install typefaster-cli
+typefaster
+```
+
+---
+
+## Install
+
+**Homebrew** (macOS / Linux)
+```bash
+brew install Anoshor/typefaster/typefaster
+```
+
+**pipx** (any OS with Python 3.11+) — fastest
+```bash
+pipx install typefaster-cli
+```
+
+Verify: `typefaster version`
+
+## Play (offline — no account, no internet)
+
+Just run it:
+```bash
+typefaster
+```
+Keyboard-only menu:
+- **Quick Race** — a fresh random quote each time; race your personal-best ghost.
+- **Time Attack** — type for 30 / 60 / 120s (←/→ to change the duration inline).
+- **Practice** — pick a mode/ghost.
+- **Daily Challenge** — same quote for everyone each day, local leaderboard.
+- **Stats / History / Profile / Leaderboard / Settings**.
+
+Live WPM, accuracy, progress, and an animated ghost bar. Backspace corrects
+mistakes (original errors still count, MonkeyType-style). All progress is saved
+locally in SQLite.
+
+Direct commands too:
+```bash
+typefaster race                      # quote race
+typefaster race --mode time --time 60
+typefaster daily
+typefaster stats   |   typefaster history
+```
+
+## Play online (multiplayer lobbies)
+
+It works out of the box against the public server — **no setup**. From the main
+menu pick **Account** to register/login, then **Play Online**:
+
+```text
+Account      → Register / Login (password, GitHub, or Google)
+Play Online  → ➕ Create a lobby  → share the join code
+             → or type a friend's code + Enter to join
+```
+In the waiting room press **R** to ready; the **server** runs the countdown,
+sends everyone the same quote, shows live progress bars, and scores results
+authoritatively (with anti-cheat). **Esc** leaves.
+
+Prefer the CLI?
+```bash
+typefaster register <name>      # or: typefaster login --github / --google
+typefaster lobby create --name "Friday" --time 60
+typefaster lobby join ABC123
+typefaster leaderboard global   # global | daily | weekly
+```
+
+## Self-host the server (optional)
+
+The game ships pointing at a public server, but you can run your own:
+```bash
+git clone https://github.com/Anoshor/typefaster-cli && cd typefaster-cli
+cp .env.example .env            # set TYPEFASTER_JWT_SECRET
+make up                         # Redis + FastAPI server on :8000 (Docker)
+typefaster config set-server http://localhost:8000
+```
+Deploy guides: [`docs/deploy-oracle.md`](docs/deploy-oracle.md) (free 24/7 VM) ·
+[`docs/deploy-fly.md`](docs/deploy-fly.md) · TLS + hardening in
+[`docs/SECURITY-REVIEW.md`](docs/SECURITY-REVIEW.md).
+
+## How it works
+
+- **Client**: Python · Typer (CLI) · Textual + Rich (TUI) · SQLite (local
+  progress) · httpx + websockets (online).
+- **Server**: FastAPI · WebSockets · Redis · Pydantic — **server-authoritative**
+  race timing and scoring.
+- Deep dive: [`docs/DEEPDIVE.md`](docs/DEEPDIVE.md) · architecture:
+  [`docs/architecture.md`](docs/architecture.md).
+
+## Develop
+
+```bash
+make install     # editable install + dev deps
+make play        # run it
+make check       # ruff + mypy + pytest
+```
+Contributions welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE). Crafted by **Anoshor Paul**.

typefaster_cli-0.2.0/README.md

@@ -0,0 +1,113 @@
+# ⌨ TYPEFASTER
+
+[![CI](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/typefaster-cli)](https://pypi.org/project/typefaster-cli/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+A **terminal-first** typing game inspired by MonkeyType and TypeRacer — race
+quotes, beat your ghost, climb leaderboards, and play **live multiplayer** with
+friends. Pure TUI, no browser, no GUI.
+
+```bash
+brew install Anoshor/typefaster/typefaster   # or: pipx install typefaster-cli
+typefaster
+```
+
+---
+
+## Install
+
+**Homebrew** (macOS / Linux)
+```bash
+brew install Anoshor/typefaster/typefaster
+```
+
+**pipx** (any OS with Python 3.11+) — fastest
+```bash
+pipx install typefaster-cli
+```
+
+Verify: `typefaster version`
+
+## Play (offline — no account, no internet)
+
+Just run it:
+```bash
+typefaster
+```
+Keyboard-only menu:
+- **Quick Race** — a fresh random quote each time; race your personal-best ghost.
+- **Time Attack** — type for 30 / 60 / 120s (←/→ to change the duration inline).
+- **Practice** — pick a mode/ghost.
+- **Daily Challenge** — same quote for everyone each day, local leaderboard.
+- **Stats / History / Profile / Leaderboard / Settings**.
+
+Live WPM, accuracy, progress, and an animated ghost bar. Backspace corrects
+mistakes (original errors still count, MonkeyType-style). All progress is saved
+locally in SQLite.
+
+Direct commands too:
+```bash
+typefaster race                      # quote race
+typefaster race --mode time --time 60
+typefaster daily
+typefaster stats   |   typefaster history
+```
+
+## Play online (multiplayer lobbies)
+
+It works out of the box against the public server — **no setup**. From the main
+menu pick **Account** to register/login, then **Play Online**:
+
+```text
+Account      → Register / Login (password, GitHub, or Google)
+Play Online  → ➕ Create a lobby  → share the join code
+             → or type a friend's code + Enter to join
+```
+In the waiting room press **R** to ready; the **server** runs the countdown,
+sends everyone the same quote, shows live progress bars, and scores results
+authoritatively (with anti-cheat). **Esc** leaves.
+
+Prefer the CLI?
+```bash
+typefaster register <name>      # or: typefaster login --github / --google
+typefaster lobby create --name "Friday" --time 60
+typefaster lobby join ABC123
+typefaster leaderboard global   # global | daily | weekly
+```
+
+## Self-host the server (optional)
+
+The game ships pointing at a public server, but you can run your own:
+```bash
+git clone https://github.com/Anoshor/typefaster-cli && cd typefaster-cli
+cp .env.example .env            # set TYPEFASTER_JWT_SECRET
+make up                         # Redis + FastAPI server on :8000 (Docker)
+typefaster config set-server http://localhost:8000
+```
+Deploy guides: [`docs/deploy-oracle.md`](docs/deploy-oracle.md) (free 24/7 VM) ·
+[`docs/deploy-fly.md`](docs/deploy-fly.md) · TLS + hardening in
+[`docs/SECURITY-REVIEW.md`](docs/SECURITY-REVIEW.md).
+
+## How it works
+
+- **Client**: Python · Typer (CLI) · Textual + Rich (TUI) · SQLite (local
+  progress) · httpx + websockets (online).
+- **Server**: FastAPI · WebSockets · Redis · Pydantic — **server-authoritative**
+  race timing and scoring.
+- Deep dive: [`docs/DEEPDIVE.md`](docs/DEEPDIVE.md) · architecture:
+  [`docs/architecture.md`](docs/architecture.md).
+
+## Develop
+
+```bash
+make install     # editable install + dev deps
+make play        # run it
+make check       # ruff + mypy + pytest
+```
+Contributions welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE). Crafted by **Anoshor Paul**.

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/__init__.py

@@ -1,3 +1,3 @@
 """TYPEFASTER-CLI — a terminal-first typing game."""
 
-__version__ = "0.1.4"
+__version__ = "0.2.0"

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/net/token_store.py

@@ -18,7 +18,7 @@ class Session:
     # Default points at the public TYPEFASTER server so a fresh install can
     # register/play with zero config. Override with `typefaster config set-server`
     # (e.g. a local server or your own deployment).
-    server_url: str = "http://140.245.248.113:8000"
+    server_url: str = "https://140.245.248.113.sslip.io"
     token: str | None = None
     username: str | None = None
 

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/services/daily_service.py

@@ -2,22 +2,33 @@
 
 from __future__ import annotations
 
-from datetime import date
+from datetime import UTC, date, datetime
 
 from ..domain.models import DailyChallenge, RaceRecord
 from ..infra import quote_loader
 from ..infra.repository import Repository
 
 
+def _utc_today() -> date:
+    """The daily challenge day in UTC.
+
+    Races are stored with a UTC ``started_at`` and the daily leaderboard filters
+    on that, so the day MUST be UTC too — otherwise (e.g. in IST) results land on
+    the wrong day and the challenge never updates. UTC also makes the daily
+    genuinely 'the same for everyone'.
+    """
+    return datetime.now(UTC).date()
+
+
 class DailyService:
     def __init__(self, repo: Repository) -> None:
         self._repo = repo
 
     def today(self, day: date | None = None) -> DailyChallenge:
-        day = day or date.today()
+        day = day or _utc_today()
         quote = quote_loader.daily_quote(day)
         return self._repo.get_or_create_daily(day.isoformat(), quote)
 
     def leaderboard(self, day: date | None = None, limit: int = 20) -> list[RaceRecord]:
-        day = day or date.today()
+        day = day or _utc_today()
         return self._repo.daily_leaderboard(day.isoformat(), limit=limit)

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/ui/app.py

@@ -8,10 +8,12 @@ from ..domain.models import RaceResult
 from ..services.container import App as Services
 from ..services.container import build_app
 from ..services.race_service import RaceConfig, RaceSetup
+from .screens.account import AccountScreen
 from .screens.daily import DailyScreen
 from .screens.help import HelpScreen
 from .screens.history import HistoryScreen
 from .screens.leaderboard import LeaderboardScreen
+from .screens.lobby_browser import LobbyBrowserScreen
 from .screens.main_menu import MainMenu
 from .screens.practice import PracticeScreen
 from .screens.profile import ProfileScreen
@@ -30,6 +32,8 @@ _PANELS = {
     "leaderboard": LeaderboardScreen,
     "settings": SettingsScreen,
     "help": HelpScreen,
+    "account": AccountScreen,
+    "online": LobbyBrowserScreen,
 }
 
 

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/ui/screens/_base.py

@@ -20,11 +20,15 @@ class PanelScreen(Screen[None]):
         with Vertical(id="panel-wrap"):
             yield Static(Text(self.title_text, justify="center"), id="title")
             with VerticalScroll():
-                yield Static(self.body())
+                yield Static(self.body(), id="panel-body")
             yield Static("esc back", classes="dim")
 
     def body(self) -> RenderableType:  # pragma: no cover - overridden
         return Text("")
 
+    def on_screen_resume(self) -> None:
+        # Re-query when we return here (e.g. after a race) so data is fresh.
+        self.query_one("#panel-body", Static).update(self.body())
+
     def action_back(self) -> None:
         self.app.pop_screen()

typefaster_cli-0.2.0/client/typefaster/ui/screens/account.py

@@ -0,0 +1,193 @@
+"""In-TUI account screen: register, login (password / GitHub / Google), logout.
+
+Actions are an OptionList (not single-letter keys, which would collide with the
+username/password Inputs). Network calls (blocking httpx) run in worker threads
+and post results back via ``call_from_thread``.
+"""
+
+from __future__ import annotations
+
+import contextlib
+import time
+import webbrowser
+
+from rich.text import Text
+from textual.app import ComposeResult
+from textual.containers import Vertical
+from textual.screen import Screen
+from textual.widgets import Input, OptionList, Static
+from textual.widgets.option_list import Option
+
+from ...net.api import ApiClient, ApiError
+from ...net.token_store import Session
+
+_ACTIONS = [
+    ("register", "Register (username + password)"),
+    ("login", "Login (username + password)"),
+    ("github", "Login with GitHub (browser)"),
+    ("google", "Login with Google (browser)"),
+    ("setserver", "Set server URL (from field above)"),
+    ("logout", "Logout"),
+]
+
+
+class AccountScreen(Screen[None]):
+    BINDINGS = [("escape", "back", "Back")]
+
+    def compose(self) -> ComposeResult:
+        with Vertical(id="panel-wrap"):
+            yield Static(Text("ACCOUNT", justify="center"), id="title")
+            yield Static(self._status_text(), id="acct-status")
+            yield Input(placeholder="username", id="user")
+            yield Input(placeholder="password", password=True, id="pw")
+            yield Input(placeholder="server url", id="server", value=Session.load().server_url)
+            yield OptionList(*[Option(label, id=key) for key, label in _ACTIONS])
+            yield Static(
+                Text("Tab between fields · pick an action below · esc back", justify="center"),
+                classes="dim",
+            )
+            yield Static("", id="acct-msg")
+
+    def on_mount(self) -> None:
+        self.query_one("#user", Input).focus()
+
+    def on_option_list_option_selected(self, event: OptionList.OptionSelected) -> None:
+        match event.option.id:
+            case "register":
+                self._auth("register")
+            case "login":
+                self._auth("login")
+            case "github":
+                self._oauth("github")
+            case "google":
+                self._oauth("google")
+            case "setserver":
+                self._set_server()
+            case "logout":
+                self._logout()
+
+    # ── helpers ────────────────────────────────────────────────────────
+    def _status_text(self) -> Text:
+        s = Session.load()
+        who = s.username or "not logged in"
+        return Text.from_markup(f"server: [bold]{s.server_url}[/]   ·   [bold cyan]{who}[/]")
+
+    def _msg(self, markup: str) -> None:
+        self.query_one("#acct-msg", Static).update(Text.from_markup(markup))
+
+    def _refresh_status(self) -> None:
+        self.query_one("#acct-status", Static).update(self._status_text())
+
+    def _field(self, wid: str) -> str:
+        return self.query_one(f"#{wid}", Input).value.strip()
+
+    # ── password auth ──────────────────────────────────────────────────
+    def _auth(self, kind: str) -> None:
+        user, pw = self._field("user"), self._field("pw")
+        if not user or not pw:
+            self._msg("[red]Enter a username and password first.[/]")
+            return
+        self._msg(f"[grey58]{kind.title()}ing…[/]")
+        self.run_worker(lambda: self._do_auth(kind, user, pw), thread=True, name="auth")
+
+    def _do_auth(self, kind: str, user: str, pw: str) -> None:
+        session = Session.load()
+        client = ApiClient(session)
+        try:
+            data = client.register(user, pw) if kind == "register" else client.login(user, pw)
+            session.token = data["access_token"]
+            session.username = data["username"]
+            session.save()
+            self.app.call_from_thread(self._on_auth_ok, session.username)
+        except ApiError as exc:
+            self.app.call_from_thread(self._msg, f"[red]{exc.detail}[/]")
+        finally:
+            client.close()
+
+    def _on_auth_ok(self, username: str) -> None:
+        self._refresh_status()
+        self._msg(f"[green]Logged in as[/] [bold]{username}[/]. Press esc, then 'Play Online'.")
+
+    # ── logout / server ────────────────────────────────────────────────
+    def _logout(self) -> None:
+        self.run_worker(self._do_logout, thread=True, name="logout")
+
+    def _do_logout(self) -> None:
+        session = Session.load()
+        client = ApiClient(session)
+        with contextlib.suppress(ApiError):
+            if session.logged_in:
+                client.logout()
+        client.close()
+        session.clear()
+        self.app.call_from_thread(self._after_logout)
+
+    def _after_logout(self) -> None:
+        self._refresh_status()
+        self._msg("[green]Logged out.[/]")
+
+    def _set_server(self) -> None:
+        url = self._field("server")
+        if not url:
+            return
+        session = Session.load()
+        if url.rstrip("/") != session.server_url:
+            session.token = None
+            session.username = None
+        session.server_url = url.rstrip("/")
+        session.save()
+        self._refresh_status()
+        self._msg(f"[green]Server set to[/] [bold]{session.server_url}[/]")
+
+    # ── OAuth device flow ──────────────────────────────────────────────
+    def _oauth(self, provider: str) -> None:
+        self._msg(f"[grey58]Starting {provider.title()} login…[/]")
+        self.run_worker(lambda: self._do_oauth(provider), thread=True, name="oauth")
+
+    def _do_oauth(self, provider: str) -> None:
+        session = Session.load()
+        client = ApiClient(session)
+        try:
+            start = client.oauth_start(provider)
+        except ApiError as exc:
+            self.app.call_from_thread(
+                self._msg, f"[red]{provider.title()} unavailable: {exc.detail}[/]"
+            )
+            client.close()
+            return
+
+        uri, code, device = start["verification_uri"], start["user_code"], start["device_code"]
+        interval = int(start.get("interval", 5))
+        deadline = time.time() + int(start.get("expires_in", 900))
+        self.app.call_from_thread(
+            self._msg,
+            f"Open [bold underline]{uri}[/] · enter code [bold cyan]{code}[/] · waiting…",
+        )
+        with contextlib.suppress(Exception):
+            webbrowser.open(uri)
+
+        try:
+            while time.time() < deadline:
+                time.sleep(interval)
+                try:
+                    r = client.oauth_poll(provider, device)
+                except ApiError as exc:
+                    self.app.call_from_thread(self._msg, f"[red]Login failed: {exc.detail}[/]")
+                    return
+                st = r.get("status")
+                if st == "pending":
+                    continue
+                if st == "slow_down":
+                    interval += 5
+                    continue
+                session.token = r["access_token"]
+                session.username = r["username"]
+                session.save()
+                self.app.call_from_thread(self._on_auth_ok, session.username)
+                return
+            self.app.call_from_thread(self._msg, "[red]Login timed out.[/]")
+        finally:
+            client.close()
+
+    def action_back(self) -> None:
+        self.app.pop_screen()

{typefaster_cli-0.1.4 → typefaster_cli-0.2.0}/client/typefaster/ui/screens/daily.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from datetime import date
+from datetime import UTC, datetime
 
 from rich.console import Group
 from rich.table import Table
@@ -23,15 +23,17 @@ class DailyScreen(Screen[None]):
     ]
 
     def compose(self) -> ComposeResult:
+        day = datetime.now(UTC).date().isoformat()  # UTC — matches how results are filed
         with Vertical(id="panel-wrap"):
-            yield Static(
-                Text(f"DAILY CHALLENGE · {date.today().isoformat()}", justify="center"),
-                id="title",
-            )
+            yield Static(Text(f"DAILY CHALLENGE · {day} (UTC)", justify="center"), id="title")
             with VerticalScroll():
-                yield Static(self._body())
+                yield Static(self._body(), id="panel-body")
             yield Static("⏎ play today's challenge    esc back", classes="dim")
 
+    def on_screen_resume(self) -> None:
+        # Refresh best/attempts/leaderboard after returning from a race.
+        self.query_one("#panel-body", Static).update(self._body())
+
     def _body(self) -> Group:
         svc = self.app.services  # type: ignore[attr-defined]
         challenge = svc.daily.today()