typefaster-cli 0.1.0__py3-none-any.whl

typefaster/ui/widgets/typing_field.py

@@ -0,0 +1,28 @@
+"""Renders the target text with per-character correctness coloring + caret."""
+
+from __future__ import annotations
+
+from rich.text import Text
+from textual.widgets import Static
+
+from .. import theme
+
+
+class TypingField(Static):
+    """Displays the quote, coloring each character by typed state."""
+
+    def show(self, target: str, states: list[bool | None], cursor: int) -> None:
+        text = Text()
+        for i, ch in enumerate(target):
+            if i == cursor:
+                text.append(ch, style=theme.CARET)
+            elif i < cursor:
+                state = states[i]
+                if state is True:
+                    text.append(ch, style=theme.CORRECT)
+                else:
+                    # Wrong char: keep the *target* glyph visible, mark it red.
+                    text.append(ch, style=theme.INCORRECT)
+            else:
+                text.append(ch, style=theme.PENDING)
+        self.update(text)

typefaster_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: typefaster-cli
+Version: 0.1.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-CLI
+
+[![CI](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/Anoshor/typefaster-cli/actions/workflows/ci.yml)
+[![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.
+
+> Not a web app. Not a browser game. Not a desktop GUI.
+> A polished **Python terminal application** that works offline first, then scales to internet multiplayer.
+
+```bash
+typefaster
+```
+
+…and you're racing within seconds. No login, no server, no Docker, no internet required.
+
+---
+
+## Status
+
+| Phase | Scope | State |
+|-------|-------|-------|
+| **Phase 1** | Offline experience: races, ghosts, profile, stats, history, daily challenge | ✅ **Implemented & tested** |
+| **Phase 2** | Online multiplayer: FastAPI + Redis + WebSockets, auth, lobbies, leaderboards, anti-cheat, Docker | ✅ **Implemented & tested** |
+
+Both phases are implemented. Offline play needs only `pip install`; online play
+adds a Dockerized server (see [Online play](#online-play-phase-2)).
+
+---
+
+## What Phase 1 delivers
+
+- **Instant offline races** — random quote, live WPM / accuracy / progress / timer.
+- **30 / 60 / 120 second** race modes.
+- **Ghost races** against your `personal-best`, `last`, or a `random` historical run, animated live.
+- **Local profile & stats** in SQLite — races played/won, best/avg WPM, best/avg accuracy, total chars, total time, full history.
+- **Daily challenge** — same quote for everyone each day, with a local daily leaderboard.
+- **Polished TUI** built on **Textual** + **Rich**, keyboard-only, resize-aware.
+
+## Planned CLI
+
+```bash
+typefaster                                   # launch straight into the game
+typefaster race --time 60 --ghost personal-best
+typefaster race --ghost last
+typefaster race --ghost random
+typefaster daily
+typefaster profile
+typefaster stats
+typefaster history
+```
+
+---
+
+## Tech stack
+
+**Client (Phase 1):** Python 3.11+, Typer, Rich, Textual, SQLite (stdlib), platformdirs.
+**Server (Phase 2):** FastAPI, asyncio, WebSockets, Pydantic, Redis, Docker Compose.
+
+## Repository layout
+
+```
+typefaster-cli/
+├── client/typefaster/   # CLI app: domain · services · infra · ui · net · assets
+├── server/app/          # FastAPI server: routers · ws · repositories · security
+├── shared/              # shared schemas, WS protocol, scoring, anti-cheat
+├── infra/               # redis.conf · nginx.conf (TLS + WS proxy)
+├── docs/                # architecture, schemas, protocol, deployment, roadmap
+├── tests/               # client unit · integration · UI smoke
+├── scripts/             # quote dataset tooling
+├── docker-compose.yml   # redis + server (+ nginx via --profile proxy)
+├── pyproject.toml · Makefile · README.md
+```
+
+See [`docs/architecture.md`](docs/architecture.md) for the full design.
+
+## Online play (Phase 2)
+
+Run the server stack (Redis + FastAPI + WebSockets) with Docker:
+
+```bash
+cp .env.example .env       # set TYPEFASTER_JWT_SECRET
+make up                    # redis + server on :8000  (make up-proxy adds nginx TLS)
+```
+
+Then, from the client:
+
+```bash
+typefaster register alice          # create an account
+typefaster login alice
+typefaster lobby create --name "Friday Sprint" --time 60
+typefaster lobby join ABC123       # join a friend's private lobby
+typefaster lobby list              # browse public lobbies
+typefaster leaderboard global      # global | daily | weekly
+typefaster logout
+```
+
+The server is **authoritative**: it controls race start/finish, re-scores every
+result, and runs anti-cheat before writing leaderboards. See the docs:
+
+- [API specification](docs/api-spec.md)
+- [WebSocket protocol](docs/websocket-protocol.md)
+- [Redis schema](docs/redis-schema.md)
+- [Deployment guide (single Linux VM)](docs/deployment.md)
+
+The client points at `http://localhost:8000` by default; set `server_url` in
+`~/.config/typefaster/auth.json` to target a deployed server.
+
+## Development
+
+```bash
+make install   # editable install + dev deps
+make play      # launch the game
+make test      # pytest
+make lint      # ruff
+make typecheck # mypy
+make format    # black + ruff --fix
+make check     # lint + typecheck + test (CI parity)
+```
+
+> **Note on the monorepo layout:** the importable package lives at
+> `client/typefaster`. A normal install (`pip install .`, used by Docker and end
+> users) places it on the path automatically. For local development the
+> `Makefile` exports `PYTHONPATH=client`, so `make play` / `make test` always
+> work. If you invoke tools directly, prefix with `PYTHONPATH=client` (e.g.
+> `PYTHONPATH=client python -m typefaster`).
+
+## Design preferences locked for Phase 1
+
+- **Quotes:** curated public-domain set, tagged `short` / `medium` / `long` for difficulty buckets and 30/60/120s fit.
+- **Backspace:** allowed (MonkeyType-style) — corrections permitted, original errors still count toward accuracy; exposed as a Settings toggle.
+
+## License
+
+MIT.

typefaster_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,61 @@
+typefaster/__init__.py,sha256=uqCP1MzJp9nieFYiz6ANwx0ar5DukClA7WRewqrePRQ,78
+typefaster/__main__.py,sha256=2dxSnCI2wKDhIgdMFPwlZkdbJ-GQwy6uZApfeoyFAkA,135
+typefaster/cli.py,sha256=PGkhtsID-GDSPGgSY-sFsLj4WGYXO6EsP1Nwx9-feig,6500
+typefaster/assets/__init__.py,sha256=uDRfxDegVWAPzgSUlv-yy_ILP5UTMVIa9lNTh4moyU4,43
+typefaster/assets/quotes.json,sha256=ooE992FtEyzB6-cJ6BEPx_Hfzs5iSekEb8wPvqvOHP4,73591
+typefaster/domain/__init__.py,sha256=5y9Qy9eMH_c75Gq_um7E-6qVPB1a2r0flS-yIVaCqEk,73
+typefaster/domain/anti_cheat.py,sha256=zwB5-ZPANMX63zWxwDn8d9EPtW3kf6PGQ1g-35fAQeM,1429
+typefaster/domain/calculators.py,sha256=Igj1ivDyM67Uf-7hu6hm9H2BCOAvbgaqQ_a0dU6H6t8,1438
+typefaster/domain/errors.py,sha256=AP-wzNosxDpxAwtQ8cXfhl32xVGodm3ablp2wawJeak,493
+typefaster/domain/ghost.py,sha256=ilLKCJ24nJs3NQvpetuQwJxJaeq0t6QOrGYYEydbnvQ,2072
+typefaster/domain/models.py,sha256=3WfhzH2lrtWdqxuieBOX81WnprAaNuYQepS-VLMGmoE,4418
+typefaster/domain/typing_engine.py,sha256=D27fCvog5k7i9sygVWvchNojA4cS7Rl5noU8O5AoTAo,5559
+typefaster/infra/__init__.py,sha256=i_oY7TZxRHpRRp61_m-qQWsg8qk0CTVHxHT9UGV1do4,76
+typefaster/infra/clock.py,sha256=6DZWBtaTueN0cisnFEXs9bwLuNWb1NOY8e8LiC7w8Nc,775
+typefaster/infra/config.py,sha256=Tz1waDd6QuvVYB0NE0rkbtS5a1mowsoLpx9KlFt4kuM,1229
+typefaster/infra/db.py,sha256=5S2v-o__L9EYaFAyg6WmS7eRL2qszwZIv_S23IHB4AM,942
+typefaster/infra/migrations.py,sha256=kb6VNWw42JNck3yyF_9pQUcIVzn7EaFbJsORqZBNg2g,3995
+typefaster/infra/paths.py,sha256=aH8IeRj34_-_mG4C5450bE_mvThgy3B6Xb4ZSnWxcSY,877
+typefaster/infra/quote_loader.py,sha256=OPfjJ-6Mn1oeaAgZMcsIG6Yt4FePeRngccdO6mX0Jk4,1622
+typefaster/infra/replay_store.py,sha256=dwkjHPFy9-yx3x9BC_THZoY8da3H3EChpQerzlnQGA8,474
+typefaster/infra/repository.py,sha256=WS76T0tWsySV65oB6I4C8REFLoCF3aFlciB0pDoSQ2c,2026
+typefaster/infra/sqlite_repository.py,sha256=XRtT8Q3tbi9cbuQIYCqfHly54rKF_koLT1Dw57R2OEM,14694
+typefaster/net/__init__.py,sha256=tSx4UMBc0kUlp60corti6SvOnc9fJ_n5guJlysdRUZ0,74
+typefaster/net/api.py,sha256=iD1AICf6NY8ykmE9hNNMmYNhFxnTve_jQpAzlSUTxzA,3957
+typefaster/net/commands.py,sha256=V_l9R0UniZlWUMYfcOFTOXqs8arbRBcujI2CVYslxWU,6224
+typefaster/net/token_store.py,sha256=MVTVX5kmW8wwCEJMwHAPzpUaBd2ULSo3oIIT0QNLBIo,1282
+typefaster/services/__init__.py,sha256=4VngeItS-jc6-I71DsWkaWnvHODCni7ot4kiDICfMaw,79
+typefaster/services/container.py,sha256=79AR_skykXGsneXZx-LZ6ihbV8x8yzWBBnTQIzeUzK4,1143
+typefaster/services/daily_service.py,sha256=DpLGpa3Z53_-SOTYd4tTZB2VbwXJRyl8pwMZZoI6Iww,782
+typefaster/services/ghost_service.py,sha256=U6XPMDtgi8ORvf6w-mGpyZf8aiHaDD35zZ6F3cjzSsw,1676
+typefaster/services/profile_service.py,sha256=EquonTLismSHcs3HTQlUC_Rtt3uI3CT-Q5igFwRk220,473
+typefaster/services/race_service.py,sha256=BmTMIpjkHX9Wom7PeaWRXHUHuZ4siaVtq-iey2tfwIQ,5406
+typefaster/services/stats_service.py,sha256=yLP2hwubhqUr5rPxnxWX9n5PbINpgn9dQc1RANiYBeU,1912
+typefaster/ui/__init__.py,sha256=IbB-ajsaTRD4HS4zy-fNbpkv8_broTEEhJgl_1d93q4,72
+typefaster/ui/app.py,sha256=ki1Neeb2ErZiL3gvAgwwRJ1JPKa-H7hpZ_AJFaiibOE,3430
+typefaster/ui/online_app.py,sha256=PHycCB32LGho8hHx9sfJ-o-gyiDT82CUTRRVF5ov33Y,678
+typefaster/ui/theme.py,sha256=XzJFft9L3QP4qqUbbHmZ0v3ZeWodvcUY89PhsEHqlfs,1487
+typefaster/ui/screens/__init__.py,sha256=-L4TEWNuG14Jofv6FNRLMKYGYoNquB1HvGmYV3YXYus,23
+typefaster/ui/screens/_base.py,sha256=D-XqZBOwdINhtXUXjUfPReYA_aFRDuBAItGhXjH5Fmg,983
+typefaster/ui/screens/daily.py,sha256=h2pvI4_vDQedEU-JRPRpLz6f8Bop39wW5FZoOSZ6kkY,2343
+typefaster/ui/screens/help.py,sha256=OCzQlsGWzY7CwZMAcElGxMtBmao_KRjIFse7RuABtNE,788
+typefaster/ui/screens/history.py,sha256=PQ0f5F7aHv1E6pmJvsNNYlbm59HthwAHGtYR0bX_i8s,1073
+typefaster/ui/screens/leaderboard.py,sha256=kZhuixwIZLVsHaDjwsB258sQyMBZ9dYs2Y0QdRaFpKg,1968
+typefaster/ui/screens/main_menu.py,sha256=DSJTHypdT32ieckVn5AoR7BQJfH_qxpHnJwUgR3SX3A,3435
+typefaster/ui/screens/online_race.py,sha256=6fuUUyhMOk8wl6OC1LukQPsZxyfq_KZVPzL297I0mRQ,9718
+typefaster/ui/screens/practice.py,sha256=6gvzVFYprGrbDClPArWM4COnzRi0zASrtnKjP6AREx8,2115
+typefaster/ui/screens/profile.py,sha256=1QiUkhMBH38q3Vkw5kx4O1LUZc8vrNtKF8q4p8GABAk,995
+typefaster/ui/screens/race.py,sha256=JlCxayx2W-fjnIza4ASK4Yg-UGkWSXDQv2YkndnxOMY,9961
+typefaster/ui/screens/results.py,sha256=3nXSMEO9xIBEtKRoSzpGNBnRMbX3-yToXCQ1GuLJrZY,3280
+typefaster/ui/screens/settings.py,sha256=nz0VRoRUmJxDj6CGFHiVtL0xDaz4lCvO1qa-l5NqXBE,2812
+typefaster/ui/screens/stats.py,sha256=eePL3sU729EptA2DRJOlpezVUgOjE9zPkwT_dOSF0os,2342
+typefaster/ui/widgets/__init__.py,sha256=D2YleDqZvFyzPhI501R-V8RmwDSSvOFRasAyVHpxUBo,56
+typefaster/ui/widgets/bigtext.py,sha256=6naRaTuxke6tP0Q7j67KyvMsibTlRdhdiuEiszNdKYo,2162
+typefaster/ui/widgets/live_stats.py,sha256=Q17tvAOHanhf4qS78G59sLEY-mieAUyDjyvAZN8tAaw,683
+typefaster/ui/widgets/progress_bars.py,sha256=fZTh9a0KPVK1UnRq75Jf0YzSF4r85e3xn12oSUmIzmA,1392
+typefaster/ui/widgets/typing_field.py,sha256=gYKOjytwsMEU_k5Nu9mnYLBP4smNEw4bZ6lR27_m-k0,934
+typefaster_cli-0.1.0.dist-info/METADATA,sha256=PLwCZzbbJ9wtc02W9Rkl8OsH4X95sNHcuqR4sgUl1FE,6341
+typefaster_cli-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+typefaster_cli-0.1.0.dist-info/entry_points.txt,sha256=-ix_zmJiKj-cikp7-QfkxqB6MPIYCD0hiGd36Q-XlS8,50
+typefaster_cli-0.1.0.dist-info/licenses/LICENSE,sha256=ZrmIfNfrisYorCVzUnlZHoQZxJQB06oC_0lrNMkkXls,1079
+typefaster_cli-0.1.0.dist-info/RECORD,,

typefaster_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

typefaster_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+typefaster = typefaster.cli:app

typefaster_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TYPEFASTER-CLI authors
+
+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.