interviewprep-cli 0.1.0__tar.gz

interviewprep_cli-0.1.0/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: interviewprep-cli
+Version: 0.1.0
+Summary: A CLI tool for organizing technical interview preparation
+Author-email: Tevita Mathias <mathias.tevita@icloud.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/aldohl95/InterviewPrepCli
+Project-URL: Repository, https://github.com/aldohl95/InterviewPrepCli
+Project-URL: Issues, https://github.com/aldohl95/InterviewPrepCli/issues
+Keywords: cli,leetcode,interview-prep,spaced-repetition
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Education
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: platformdirs
+Requires-Dist: click
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# InterviewPrep CLI
+
+A command-line application for organizing and optimizing technical interview preparation. Instead of tracking LeetCode problems, study notes, and review schedules across spreadsheets and multiple apps, everything lives in a single terminal-based tool with spaced repetition built in.
+
+## Features
+
+- **Problem Tracker** — full CRUD for practice attempts with problem name, pattern, difficulty, time taken, and self-assessment fields
+- **Spaced Repetition Engine** — automatic scheduling of review dates based on personal difficulty and whether hints were used
+- **Progress Dashboard** — aggregated statistics on problems solved, patterns practiced, and difficulty distribution
+- **Daily Study Planner** — shows what's due for review today with streak tracking
+- **Data Import / Export** — JSON-based backup and restore with merge and replace modes
+
+## Installation
+
+Requires Python 3.11 or higher.
+
+```bash
+git clone https://github.com/aldohl95/InterviewPrepCli.git
+cd InterviewPrepCli
+python3 -m venv .venv
+source .venv/bin/activate    # On Windows: .venv\Scripts\activate
+pip install -e ".[dev]" --no-build-isolation
+```
+
+Verify the installation:
+
+```bash
+interviewprep --help
+```
+
+## Usage
+
+### Adding a problem
+
+```bash
+interviewprep add
+```
+
+Walks through interactive prompts for problem name, pattern (e.g. "hash map"), LeetCode difficulty, personal difficulty (1–10), time taken, whether you needed help, and an optional recognition sentence.
+
+### Listing all problems
+
+```bash
+interviewprep list
+```
+
+Displays a summary table with problem number, name, date attempted, personal difficulty, and whether it needs resolving.
+
+### Viewing full details
+
+```bash
+interviewprep view 1
+```
+
+Shows every field for the numbered problem.
+
+### Editing a problem
+
+```bash
+interviewprep edit 1
+```
+
+Prompts field-by-field with current values as defaults. Press Enter to keep any field unchanged.
+
+### Deleting a problem
+
+```bash
+interviewprep delete 1
+```
+
+Confirmation prompt before deletion.
+
+### Logging a new review
+
+```bash
+interviewprep review 1
+```
+
+Creates a new attempt record for an existing problem and calculates the next review date based on the spaced repetition algorithm.
+
+### Progress dashboard
+
+```bash
+interviewprep dashboard
+```
+
+Displays statistics: total problems solved, breakdown by LeetCode difficulty, top patterns practiced, and problems still needing resolve.
+
+### Daily study planner
+
+```bash
+interviewprep today
+```
+
+Shows problems due for review today, falls back to upcoming reviews if nothing is due, and tracks your daily streak.
+
+### Exporting data
+
+```bash
+interviewprep export --output=backup.json
+```
+
+Writes all problems to a JSON file for backup.
+
+### Importing data
+
+```bash
+interviewprep import --input=backup.json --mode=merge
+interviewprep import --input=backup.json --mode=replace
+```
+
+Merge mode adds imported problems to existing data. Replace mode overwrites everything.
+
+## Architecture
+
+### Directory structure
+### Full project structure
+
+```
+interviewprep-cli/
+├── src/
+│   └── interviewprep/
+│       ├── __init__.py
+│       ├── cli.py           — Click entry point and command registration
+│       ├── models.py        — Problem dataclass and LeetcodeDifficulty enum
+│       ├── storage.py       — JSON persistence via platformdirs
+│       ├── prompts.py       — shared interactive prompt logic
+│       ├── scheduler.py     — spaced repetition algorithm
+│       └── commands/        — one file per CLI command
+│           ├── __init__.py
+│           ├── add.py
+│           ├── list.py
+│           ├── view.py
+│           ├── edit.py
+│           ├── delete.py
+│           ├── review.py
+│           ├── dashboard.py
+│           ├── today.py
+│           ├── export.py
+│           └── import_problems.py
+│
+├── tests/
+│   ├── test_basic.py
+│   ├── test_model.py
+│   ├── test_storage.py
+│   ├── test_scheduler.py
+│   └── test_command.py
+│
+├── docs/
+│   └── scheduler.md         — algorithm design and tradeoffs
+│
+├── README.md
+├── SPEC.md
+├── LICENSE
+└── pyproject.toml           — project config, dependencies, tool settings
+```
+
+### Data storage
+
+Problems are stored as JSON at the platform-appropriate user data directory (via `platformdirs`):
+
+- **Linux**: `~/.local/share/interviewprep/problems.json`
+- **macOS**: `~/Library/Application Support/interviewprep/problems.json`
+- **Windows**: `%LOCALAPPDATA%\interviewprep\problems.json`
+
+### Spaced repetition
+
+A custom piecewise algorithm designed for interview preparation. First reviews use gentle intervals (1 or 3 days). Subsequent reviews scale from 1 day (needed help or difficulty ≥ 8) up to 30 days (mastered). Full details in `docs/scheduler.md`.
+
+## Design Decisions
+
+Several deliberate tradeoffs are documented in-code and worth calling out:
+
+- **JSON over SQLite** — chosen for simplicity and human-readable data. SQLite migration is noted as future work.
+- **Custom scheduling algorithm over SM-2** — the industry-standard SM-2 algorithm was overkill for the expected data size. The custom algorithm is simpler to test, defend, and reason about.
+- **Problem name as identifier** — prior attempts are looked up by name rather than by a separate ID system. Acceptable tradeoff for a single-user tool.
+- **New attempts as separate records** — the `review` command creates new records rather than mutating existing ones, preserving history.
+- **Edit does not recalculate schedules** — editing a problem is treated as metadata correction. Users who want to update their schedule should use `review` instead.
+
+## Development
+
+### Running tests
+
+```bash
+pytest
+```
+
+Current test count: **42 tests passing** across models, storage, scheduler, and all commands.
+
+### Formatting and linting
+
+```bash
+black src/ tests/
+ruff check src/ tests/
+```
+
+Configuration lives in `pyproject.toml`.
+
+### Test coverage areas
+
+- Data model validation (boundary values, invalid inputs)
+- Storage round-trip (save then load produces equivalent data)
+- Scheduler algorithm (every branch and boundary tested)
+- Every CLI command (success paths and error cases)
+
+## Future Work
+
+- Migrate storage layer from JSON to SQLite for efficient querying
+- Add CSV import/export format
+- Refactor to split `Problem` (identity) from `Attempt` (per-session data)
+- Recalculate `next_review_date` on edit when scheduling fields change
+- Add filtering to `list` command (by pattern, difficulty, date range)
+- CI pipeline with GitHub Actions
+
+## Tech Stack
+
+- **Python 3.11+**
+- **Click** — CLI framework
+- **Rich** — formatted terminal output
+- **platformdirs** — cross-platform data directory handling
+- **pytest** — testing framework
+- **Black** and **Ruff** — code formatting and linting
+
+## License
+
+MIT

interviewprep_cli-0.1.0/README.md

@@ -0,0 +1,226 @@
+# InterviewPrep CLI
+
+A command-line application for organizing and optimizing technical interview preparation. Instead of tracking LeetCode problems, study notes, and review schedules across spreadsheets and multiple apps, everything lives in a single terminal-based tool with spaced repetition built in.
+
+## Features
+
+- **Problem Tracker** — full CRUD for practice attempts with problem name, pattern, difficulty, time taken, and self-assessment fields
+- **Spaced Repetition Engine** — automatic scheduling of review dates based on personal difficulty and whether hints were used
+- **Progress Dashboard** — aggregated statistics on problems solved, patterns practiced, and difficulty distribution
+- **Daily Study Planner** — shows what's due for review today with streak tracking
+- **Data Import / Export** — JSON-based backup and restore with merge and replace modes
+
+## Installation
+
+Requires Python 3.11 or higher.
+
+```bash
+git clone https://github.com/aldohl95/InterviewPrepCli.git
+cd InterviewPrepCli
+python3 -m venv .venv
+source .venv/bin/activate    # On Windows: .venv\Scripts\activate
+pip install -e ".[dev]" --no-build-isolation
+```
+
+Verify the installation:
+
+```bash
+interviewprep --help
+```
+
+## Usage
+
+### Adding a problem
+
+```bash
+interviewprep add
+```
+
+Walks through interactive prompts for problem name, pattern (e.g. "hash map"), LeetCode difficulty, personal difficulty (1–10), time taken, whether you needed help, and an optional recognition sentence.
+
+### Listing all problems
+
+```bash
+interviewprep list
+```
+
+Displays a summary table with problem number, name, date attempted, personal difficulty, and whether it needs resolving.
+
+### Viewing full details
+
+```bash
+interviewprep view 1
+```
+
+Shows every field for the numbered problem.
+
+### Editing a problem
+
+```bash
+interviewprep edit 1
+```
+
+Prompts field-by-field with current values as defaults. Press Enter to keep any field unchanged.
+
+### Deleting a problem
+
+```bash
+interviewprep delete 1
+```
+
+Confirmation prompt before deletion.
+
+### Logging a new review
+
+```bash
+interviewprep review 1
+```
+
+Creates a new attempt record for an existing problem and calculates the next review date based on the spaced repetition algorithm.
+
+### Progress dashboard
+
+```bash
+interviewprep dashboard
+```
+
+Displays statistics: total problems solved, breakdown by LeetCode difficulty, top patterns practiced, and problems still needing resolve.
+
+### Daily study planner
+
+```bash
+interviewprep today
+```
+
+Shows problems due for review today, falls back to upcoming reviews if nothing is due, and tracks your daily streak.
+
+### Exporting data
+
+```bash
+interviewprep export --output=backup.json
+```
+
+Writes all problems to a JSON file for backup.
+
+### Importing data
+
+```bash
+interviewprep import --input=backup.json --mode=merge
+interviewprep import --input=backup.json --mode=replace
+```
+
+Merge mode adds imported problems to existing data. Replace mode overwrites everything.
+
+## Architecture
+
+### Directory structure
+### Full project structure
+
+```
+interviewprep-cli/
+├── src/
+│   └── interviewprep/
+│       ├── __init__.py
+│       ├── cli.py           — Click entry point and command registration
+│       ├── models.py        — Problem dataclass and LeetcodeDifficulty enum
+│       ├── storage.py       — JSON persistence via platformdirs
+│       ├── prompts.py       — shared interactive prompt logic
+│       ├── scheduler.py     — spaced repetition algorithm
+│       └── commands/        — one file per CLI command
+│           ├── __init__.py
+│           ├── add.py
+│           ├── list.py
+│           ├── view.py
+│           ├── edit.py
+│           ├── delete.py
+│           ├── review.py
+│           ├── dashboard.py
+│           ├── today.py
+│           ├── export.py
+│           └── import_problems.py
+│
+├── tests/
+│   ├── test_basic.py
+│   ├── test_model.py
+│   ├── test_storage.py
+│   ├── test_scheduler.py
+│   └── test_command.py
+│
+├── docs/
+│   └── scheduler.md         — algorithm design and tradeoffs
+│
+├── README.md
+├── SPEC.md
+├── LICENSE
+└── pyproject.toml           — project config, dependencies, tool settings
+```
+
+### Data storage
+
+Problems are stored as JSON at the platform-appropriate user data directory (via `platformdirs`):
+
+- **Linux**: `~/.local/share/interviewprep/problems.json`
+- **macOS**: `~/Library/Application Support/interviewprep/problems.json`
+- **Windows**: `%LOCALAPPDATA%\interviewprep\problems.json`
+
+### Spaced repetition
+
+A custom piecewise algorithm designed for interview preparation. First reviews use gentle intervals (1 or 3 days). Subsequent reviews scale from 1 day (needed help or difficulty ≥ 8) up to 30 days (mastered). Full details in `docs/scheduler.md`.
+
+## Design Decisions
+
+Several deliberate tradeoffs are documented in-code and worth calling out:
+
+- **JSON over SQLite** — chosen for simplicity and human-readable data. SQLite migration is noted as future work.
+- **Custom scheduling algorithm over SM-2** — the industry-standard SM-2 algorithm was overkill for the expected data size. The custom algorithm is simpler to test, defend, and reason about.
+- **Problem name as identifier** — prior attempts are looked up by name rather than by a separate ID system. Acceptable tradeoff for a single-user tool.
+- **New attempts as separate records** — the `review` command creates new records rather than mutating existing ones, preserving history.
+- **Edit does not recalculate schedules** — editing a problem is treated as metadata correction. Users who want to update their schedule should use `review` instead.
+
+## Development
+
+### Running tests
+
+```bash
+pytest
+```
+
+Current test count: **42 tests passing** across models, storage, scheduler, and all commands.
+
+### Formatting and linting
+
+```bash
+black src/ tests/
+ruff check src/ tests/
+```
+
+Configuration lives in `pyproject.toml`.
+
+### Test coverage areas
+
+- Data model validation (boundary values, invalid inputs)
+- Storage round-trip (save then load produces equivalent data)
+- Scheduler algorithm (every branch and boundary tested)
+- Every CLI command (success paths and error cases)
+
+## Future Work
+
+- Migrate storage layer from JSON to SQLite for efficient querying
+- Add CSV import/export format
+- Refactor to split `Problem` (identity) from `Attempt` (per-session data)
+- Recalculate `next_review_date` on edit when scheduling fields change
+- Add filtering to `list` command (by pattern, difficulty, date range)
+- CI pipeline with GitHub Actions
+
+## Tech Stack
+
+- **Python 3.11+**
+- **Click** — CLI framework
+- **Rich** — formatted terminal output
+- **platformdirs** — cross-platform data directory handling
+- **pytest** — testing framework
+- **Black** and **Ruff** — code formatting and linting
+
+## License
+
+MIT

interviewprep_cli-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "interviewprep-cli"
+version = "0.1.0"
+description = "A CLI tool for organizing technical interview preparation"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+authors = [
+    {name = "Tevita Mathias", email = "mathias.tevita@icloud.com" }
+]
+keywords = ["cli", "leetcode", "interview-prep", "spaced-repetition"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Education",
+]
+
+
+dependencies = ["platformdirs", "click", "rich"]
+[project.urls]
+Homepage = "https://github.com/aldohl95/InterviewPrepCli"
+Repository = "https://github.com/aldohl95/InterviewPrepCli"
+Issues = "https://github.com/aldohl95/InterviewPrepCli/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4",
+    "pytest-cov>=4.1",
+    "black >= 24.0",
+    "ruff >= 0.4",
+]
+
+[project.scripts]
+interviewprep = "interviewprep.cli:main"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+target-version = ["py311"]
+line-length = 88
+
+[tool.ruff]
+line-length = 88
+target-version="py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W"]

interviewprep_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

interviewprep_cli-0.1.0/src/interviewprep/cli.py

@@ -0,0 +1,29 @@
+import click
+from interviewprep.commands.add import add
+from interviewprep.commands.list import list_problems
+from interviewprep.commands.view import view
+from interviewprep.commands.edit import edit
+from interviewprep.commands.delete import delete
+from interviewprep.commands.review import review
+from interviewprep.commands.dashboard import dashboard
+from interviewprep.commands.today import today
+from interviewprep.commands.export import export
+from interviewprep.commands.import_problems import import_problems
+
+
+@click.group()
+def main():
+    """Interview CLI - manage your technical interview preparation."""
+    pass
+
+
+main.add_command(add)
+main.add_command(list_problems)
+main.add_command(view)
+main.add_command(edit)
+main.add_command(delete)
+main.add_command(review)
+main.add_command(dashboard)
+main.add_command(today)
+main.add_command(export)
+main.add_command(import_problems)

interviewprep_cli-0.1.0/src/interviewprep/commands/add.py

@@ -0,0 +1,20 @@
+import click
+from interviewprep.storage import save_problems, load_problems, find_attempts_by_name
+from interviewprep.prompts import prompt_for_problem
+from interviewprep.scheduler import calculate_next_review_date
+from interviewprep.streak import update_streak
+
+
+@click.command()
+def add():
+    click.echo("===Add New Problem===")
+
+    problem = prompt_for_problem()
+    problems = load_problems()
+    prior = find_attempts_by_name(problems, problem.problem_name)
+    problem.next_review_date = calculate_next_review_date(problem, prior)
+    problems.append(problem)
+    save_problems(problems)
+    update_streak()
+
+    click.echo(f"\nSaved '{problem.problem_name}' saved successfully")

interviewprep_cli-0.1.0/src/interviewprep/commands/dashboard.py

@@ -0,0 +1,81 @@
+import click
+from interviewprep.storage import load_problems, find_attempts_by_needs_resolve
+from rich.console import Console
+from rich.table import Table
+import heapq
+
+
+@click.command()
+def dashboard():
+    problems = load_problems()
+    console = Console()
+    freq_table = Table()
+    average_difficulty_table = Table()
+    resolve_count_table = Table()
+    leetcode_difficulty_table = Table()
+    pattern_frequency = {}
+    difficulty_frequency = {}
+    personal_difficulty_frequency = {}
+
+    leetcode_difficulty_table.add_column("#")
+    leetcode_difficulty_table.add_column("Leetcode Difficulty")
+    leetcode_difficulty_table.add_column("Solved Count")
+    freq_table.add_column("#")
+    freq_table.add_column("Pattern")
+    freq_table.add_column("Solved Count")
+    average_difficulty_table.add_column("#")
+    average_difficulty_table.add_column("Pattern")
+    average_difficulty_table.add_column("Average Personal Difficulty")
+    resolve_count_table.add_column("Total Resolves Needed")
+
+    if not problems:
+        click.echo("No Saved Problems yet")
+        return
+
+    # for Leetcode Difficulty
+    for problem in problems:
+        difficulty_frequency[problem.leetcode_difficulty.value] = (
+            1 + difficulty_frequency.get(problem.leetcode_difficulty.value, 0)
+        )
+
+    for i, (difficulty, count) in enumerate(difficulty_frequency.items(), start=1):
+        leetcode_difficulty_table.add_row(str(i), difficulty, str(count))
+
+    # for patter frequency
+    for problem in problems:
+        pattern_frequency[problem.pattern] = 1 + pattern_frequency.get(
+            problem.pattern, 0
+        )
+
+    top_five_patterns = heapq.nlargest(
+        5, pattern_frequency.items(), key=lambda item: item[1]
+    )
+
+    for i, (pattern, count) in enumerate(top_five_patterns, start=1):
+        freq_table.add_row(str(i), pattern, str(count))
+
+    # for average difficulty
+    for problem in problems:
+        pattern = problem.pattern
+        difficulty = problem.personal_difficulty
+
+        if pattern not in personal_difficulty_frequency:
+            personal_difficulty_frequency[pattern] = {"total_difficulty": 0, "count": 0}
+
+        personal_difficulty_frequency[pattern]["total_difficulty"] += difficulty
+        personal_difficulty_frequency[pattern]["count"] += 1
+
+    for i, (pattern, count) in enumerate(
+        personal_difficulty_frequency.items(), start=1
+    ):
+        average = count["total_difficulty"] / count["count"]
+        average_difficulty_table.add_row(str(i), pattern, str(average))
+
+    # problems needing resolve
+    resolve_problems = find_attempts_by_needs_resolve(problems, True)
+    resolve_count_table.add_row(str(len(resolve_problems)))
+
+    console.print(leetcode_difficulty_table)
+    console.print(freq_table)
+    console.print(average_difficulty_table)
+    console.print(resolve_count_table)