k-hunter 0.3.0__tar.gz

k_hunter-0.3.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: k-hunter
+Version: 0.3.0
+Summary: Keyboard typing trainer app 
+Keywords: typing,trainer,terminal,tui,textual
+Author: Rivkat Karimov
+Author-email: Rivkat Karimov <redscorpion32.rk@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Education
+Classifier: Topic :: Terminals
+Requires-Dist: platformdirs>=4.5.1
+Requires-Dist: textual>=7.5.0
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/spaghetti-backend/k-hunter
+Project-URL: Repository, https://github.com/spaghetti-backend/k-hunter
+Project-URL: Issues, https://github.com/spaghetti-backend/k-hunter/issues
+Description-Content-Type: text/markdown
+
+![Logo](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/logo.webp)
+
+# KeyHunter
+
+A simple terminal-based typing trainer built with [Textual].  
+Minimalist interface, flexible configuration, and progress tracking — right in
+your terminal.
+
+---
+
+## Project Status
+
+The project is currently under development.  
+Features are gradually expanding and may change over time.
+
+---
+
+## Features
+
+<details>
+<summary><strong>Training Modes</strong></summary>
+
+Available modes:
+
+- Standard multi-line mode  
+- Scrolling line mode  
+
+![StandardEngine](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/typer.webp)
+
+</details>
+
+<details>
+<summary><strong>Flexible Configuration</strong></summary>
+
+- Content type selection  
+- Adjustable word count  
+- Customizable typing area  
+
+![TyperSettings](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/typing_settings.webp)  
+![ContentSettings](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/content_settings.webp)
+
+</details>
+
+<details>
+<summary><strong>Statistics & Profile</strong></summary>
+
+View training results and track your progress.
+
+![Profile](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/profile.webp)
+
+</details>
+
+---
+
+## Requirements
+
+- Python 3.10 or higher  
+- Any modern terminal  
+
+---
+
+## Installation
+
+It is recommended to install CLI applications in an isolated environment.
+
+### Using uv
+
+```bash
+uv tool install keyhunter
+```
+
+### Using pipx
+
+```bash
+pipx install keyhunter
+```
+
+### Using pip
+
+```bash
+pip install keyhunter
+```
+
+Using [pipx] or [uv] is recommended for CLI tools.
+
+## Usage
+
+Run the application with:
+
+```bash
+keyhunter
+```
+
+Hotkeys are displayed in the bottom panel of the interface.
+
+## Roadmap
+
+- [ ] Improved navigation
+- [ ] Advanced statistics
+- [ ] Additional languages
+- [ ] Code snippet training mode
+
+<!-- external Links -->
+[Textual]: https://textual.textualize.io
+[uv]: https://docs.astral.sh/uv
+[pipx]: https://github.com/pypa/pipx
+

k_hunter-0.3.0/README.md

@@ -0,0 +1,107 @@
+![Logo](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/logo.webp)
+
+# KeyHunter
+
+A simple terminal-based typing trainer built with [Textual].  
+Minimalist interface, flexible configuration, and progress tracking — right in
+your terminal.
+
+---
+
+## Project Status
+
+The project is currently under development.  
+Features are gradually expanding and may change over time.
+
+---
+
+## Features
+
+<details>
+<summary><strong>Training Modes</strong></summary>
+
+Available modes:
+
+- Standard multi-line mode  
+- Scrolling line mode  
+
+![StandardEngine](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/typer.webp)
+
+</details>
+
+<details>
+<summary><strong>Flexible Configuration</strong></summary>
+
+- Content type selection  
+- Adjustable word count  
+- Customizable typing area  
+
+![TyperSettings](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/typing_settings.webp)  
+![ContentSettings](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/content_settings.webp)
+
+</details>
+
+<details>
+<summary><strong>Statistics & Profile</strong></summary>
+
+View training results and track your progress.
+
+![Profile](https://raw.githubusercontent.com/spaghetti-backend/keyhunter/main/docs/profile.webp)
+
+</details>
+
+---
+
+## Requirements
+
+- Python 3.10 or higher  
+- Any modern terminal  
+
+---
+
+## Installation
+
+It is recommended to install CLI applications in an isolated environment.
+
+### Using uv
+
+```bash
+uv tool install keyhunter
+```
+
+### Using pipx
+
+```bash
+pipx install keyhunter
+```
+
+### Using pip
+
+```bash
+pip install keyhunter
+```
+
+Using [pipx] or [uv] is recommended for CLI tools.
+
+## Usage
+
+Run the application with:
+
+```bash
+keyhunter
+```
+
+Hotkeys are displayed in the bottom panel of the interface.
+
+## Roadmap
+
+- [ ] Improved navigation
+- [ ] Advanced statistics
+- [ ] Additional languages
+- [ ] Code snippet training mode
+
+<!-- external Links -->
+[Textual]: https://textual.textualize.io
+[uv]: https://docs.astral.sh/uv
+[pipx]: https://github.com/pypa/pipx
+

k_hunter-0.3.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "k-hunter"
+version = "0.3.0"
+description = "Keyboard typing trainer app "
+
+requires-python = ">=3.10"
+dependencies = [
+    "platformdirs>=4.5.1",
+    "textual>=7.5.0",
+]
+
+authors = [
+    { name = "Rivkat Karimov", email = "redscorpion32.rk@gmail.com" }
+]
+license = "MIT"
+readme = "README.md"
+keywords = ["typing", "trainer", "terminal", "tui", "textual"]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Education",
+    "Topic :: Terminals",
+]
+
+[project.urls]
+Homepage = "https://github.com/spaghetti-backend/k-hunter"
+Repository = "https://github.com/spaghetti-backend/k-hunter"
+Issues = "https://github.com/spaghetti-backend/k-hunter/issues"
+
+[project.scripts]
+k-hunter = "k_hunter.main:main"
+
+[build-system]
+requires = ["uv_build>=0.9.29,<0.10"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "textual-dev>=1.8.0",
+]

k_hunter-0.3.0/src/k_hunter/const.py

@@ -0,0 +1,106 @@
+from typing import Final
+
+
+#
+# Settings
+#
+APP_NAME: Final = "k_hunter"
+TYPING_SESSIONS_STORAGE_NAME: Final = "stat.db"
+SETTINGS_STORAGE_NAME: Final = "settings.json"
+DATASETS_STORAGE_PATH: Final = "k_hunter.content.datasets"
+NATURAL_LANGUAGE_KEY: Final = "natural_language"
+PROGRAMMING_LANGUAGE_KEY: Final = "programming_language"
+SIMPLE_FILENAME: Final = "simple_text/simple"
+COMMON_DIR: Final = "common"
+
+THEME: Final = "nord"
+
+SLE_WIDTH: Final = 70
+SLE_MIN_WIDTH: Final = 50
+SLE_MAX_WIDTH: Final = 120
+SLE_WIDTH_STEPS: Final = 8
+SLE_HEIGHT: Final = 1
+SLE_MIN_HEIGHT: Final = 1
+SLE_MAX_HEIGHT: Final = 1
+SLE_START_FROM_CENTER: Final = True
+
+SE_WIDTH: Final = 70
+SE_MIN_WIDTH: Final = 50
+SE_MAX_WIDTH: Final = 120
+SE_WIDTH_STEPS: Final = 8
+SE_HEIGHT: Final = 5
+SE_MIN_HEIGHT: Final = 3
+SE_MAX_HEIGHT: Final = 9
+SE_HEIGHT_STEPS: Final = 4
+
+WORDS_COUNT: Final = 50
+MIN_WORDS_COUNT: Final = 20
+MAX_WORDS_COUNT: Final = 100
+
+UPPER_PERCENT: Final = 0
+MIN_UPPER_PERCENT: Final = 0
+MAX_UPPER_PERCENT: Final = 30
+
+KEYWORDS_COUNT: Final = 50
+MIN_KEYWORDS_COUNT: Final = 20
+MAX_KEYWORDS_COUNT: Final = 100
+#
+# Field keys
+#
+THEME_KEY: Final = "theme"
+LANGUAGE_KEY: Final = "language"
+TYPER_KEY: Final = "typer"
+CONTENT_KEY: Final = "content"
+
+ENGINE_KEY: Final = "engine"
+BORDER_KEY: Final = "border"
+SLE_KEY: Final = "single_line_engine"
+SE_KEY: Final = "standard_engine"
+
+WIDTH_KEY: Final = "width"
+MIN_WIDTH_KEY: Final = "min_width"
+MAX_WIDTH_KEY: Final = "max_width"
+
+HEIGHT_KEY: Final = "height"
+MIN_HEIGHT_KEY: Final = "min_height"
+MAX_HEIGHT_KEY: Final = "max_height"
+
+SLE_START_FROM_CENTER_KEY: Final = "start_from_center"
+
+CONTENT_TYPE_KEY: Final = "content_type"
+CATEGORY_KEY: Final = "category"
+CONTENT_FILES_KEY: Final = "content_files"
+COMMON_WORDS_KEY: Final = "common_words"
+WORDS_COUNT_KEY: Final = "words_count"
+WORDS_MIN_COUNT_KEY: Final = "min_words_count"
+WORDS_MAX_COUNT_KEY: Final = "max_words_count"
+UPPER_PERCENT_KEY: Final = "upper_percent"
+MIN_UPPER_PERCENT_KEY: Final = "min_upper_percent"
+MAX_UPPER_PERCENT_KEY: Final = "max_upper_percent"
+KEYWORDS_COUNT_KEY: Final = "keywords_count"
+KEYWORDS_MIN_COUNT_KEY: Final = "min_keywords_count"
+KEYWORDS_MAX_COUNT_KEY: Final = "max_keywords_count"
+# CONTENT_LENGHT_KEY: Final = "content_lenght"  #
+CODE_SAMPLE_TYPE_KEY: Final = "sample_type"
+
+CHAR_KEY: Final = "char"
+TOTAL_KEY: Final = "total"
+CORRECT_KEY: Final = "correct"
+TOTAL_CHARS_KEY: Final = "total_chars"
+CORRECT_CHARS_KEY: Final = "correct_chars"
+ELAPSED_TIME_MS_KEY: Final = "elapsed_time_ms"
+ACCURACY_KEY: Final = "accuracy"
+SPEED_KEY: Final = "speed"
+TYPING_SESSION_ID_KEY: Final = "typing_session_id"
+
+#
+# Keystrokes
+#
+MILLISECONDS_MULTIPLIER: Final = 1000
+PERCENT_SCALE_2DP: Final = 10_000
+FLOAT_TO_INT_SCALE_2DP: Final = 100
+
+#
+# Typer
+#
+BORDER_EXPANSION: Final = 2