cpkb 2.0.1__tar.gz

cpkb-2.0.1/LICENSE

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

cpkb-2.0.1/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: cpkb
+Version: 2.0.1
+Summary: A terminal-first Competitive Programming Knowledge Base
+Author: Aarav Shah
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Aaravshah2907/cpkb
+Project-URL: Repository, https://github.com/Aaravshah2907/cpkb
+Project-URL: Issues, https://github.com/Aaravshah2907/cpkb/issues
+Project-URL: Changelog, https://github.com/Aaravshah2907/cpkb/releases
+Keywords: competitive-programming,snippets,knowledge-base,terminal,tui
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=0.47.0
+Requires-Dist: cryptography>=41.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-mock>=3.12; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# Competitive Programming Knowledge Base (CPKB)
+
+![CPKB TUI Gallery](https://raw.githubusercontent.com/Aaravshah2907/cpkb/main/intro-image.png)
+
+CPKB is a local, terminal-first knowledge base designed to store, search, and track usages of competitive programming snippets, algorithms, and tricks. It uses SQLite for storage, keeping your snippets incredibly fast and perfectly organised.
+
+## Version 2.0 Features
+
+- **Store snippets**: Add code snippets with metadata like title, use case, and tags.
+- **Search snippets**: Full-text search across titles, descriptions, tags, and code.
+- **Track usage**: Record every time you use a snippet in a problem, linking to the file and optionally taking notes.
+- **Textual TUI**: A beautiful terminal UI for browsing and copying your snippets.
+- **FZF Integration**: Fuzzy find snippets directly in the terminal.
+- **Snippet Insertion**: Instantly copy code to the clipboard or append to files.
+- **Spaced Repetition (SM-2)**: Revise your knowledge base using the `revise` command with a true SM-2 spaced-repetition algorithm that tracks ease, interval, and repetitions per snippet.
+- **Password-based Encryption**: Encrypt your database at rest with a password (PBKDF2-HMAC-SHA256 key derivation). No keys stored on disk.
+- **XDG Base Directory compliant**: Stores your data safely in `~/.local/share/cpkb`.
+
+## Installation
+
+Install CPKB with `pipx`:
+
+```bash
+pipx install cpkb
+```
+
+Or install it with `pip`:
+
+```bash
+python -m pip install cpkb
+```
+
+### Homebrew
+
+After the first release is published, macOS and Linux users can install from the project tap:
+
+```bash
+brew tap Aaravshah2907/cpkb
+brew install cpkb
+```
+
+Until the tap is live, the formula template lives in `Formula/cpkb.rb`.
+
+### From Source
+
+```bash
+git clone https://github.com/Aaravshah2907/cpkb.git
+cd cpkb
+pip install -e .
+```
+
+### Local Development & Testing
+
+If you wish to contribute to the codebase or run the unit tests locally to verify the CLI and TUI functionality, set up a virtual environment and run `pytest`:
+
+```bash
+# 1. Create and activate a virtual environment
+python3 -m venv venv
+source venv/bin/activate  # On Windows use: venv\Scripts\activate
+
+# 2. Install CPKB and test dependencies
+python -m pip install -e ".[dev]"
+
+# 3. Run the test suite
+pytest
+```
+
+## Platform‑specific dependencies
+
+| Platform | Clipboard utility   | Fuzzy finder                               |
+|----------|---------------------|--------------------------------------------|
+| macOS    | `pbcopy` (built‑in) | `brew install fzf`                         |
+| Linux    | `xclip` or `xsel`   | `sudo apt-get install fzf`                 |
+| Windows  | `clip` (built‑in)   | `scoop install fzf` or `choco install fzf` |
+
+## Usage
+
+Here are the commands available in Version 2.0:
+
+### Core V1 Commands
+
+- `cpkb add`: Add a new snippet interactively.
+- `cpkb list`: List all snippets.
+- `cpkb show <id>`: Show details, code, and usages of a specific snippet.
+- `cpkb search <query>`: Search for snippets matching multiple words.
+- `cpkb use <id> <file>`: Record the usage of a snippet in a specific file.
+- `cpkb usages <id>`: List all recorded usages for a snippet.
+- `cpkb stats`: Show basic database statistics.
+- `cpkb random`: Show a random snippet for review or practice.
+- `cpkb edit <id>`: Edit a snippet's metadata and code in your default `$EDITOR`.
+- `cpkb edit-usage <id>`: Edit a past usage record.
+- `cpkb delete <id>`: Delete a snippet permanently.
+- `cpkb recent`: Show the 10 most recently added snippets.
+- `cpkb export`: Export your entire knowledge base to a single Markdown file.
+- `cpkb export-db [--encrypted]`: Export your SQLite database, optionally encrypted with a password.
+- `cpkb import <file-or-url>`: Append snippets from a CPKB `db`, `json`, `md`, or `html` export.
+- `cpkb import --defaults`: Import bundled C++ STL competitive-programming cheatsheets with special `cp_` IDs.
+- `cpkb import --list-defaults`: Preview the bundled cheatsheets before importing.
+- `cpkb backup`: Manually trigger a backup of the SQLite database.
+
+### New V2 Commands
+
+- `cpkb tui`: Launch the interactive Textual TUI (press `c` to copy a snippet).
+- `cpkb fzf`: Interactively fuzzy search snippets using `fzf`.
+- `cpkb copy <id> [-f <file>]`: Instantly copy the snippet's code to your system clipboard (uses `pbcopy` on macOS, `xclip`/`xsel` on Linux, `clip` on Windows) or append to a file.
+- `cpkb revise`: Start a spaced-repetition session — the SM-2 algorithm selects the most overdue snippet, shows the title, then reveals the code. Rate your recall (0–5) to schedule the next review.
+- `cpkb srs-stats`: Show spaced-repetition statistics (total reviewed, due now, avg ease factor).
+- `cpkb encrypt-db`: Encrypt the database with a password (PBKDF2 + Fernet). No key files are stored.
+- `cpkb decrypt-db`: Decrypt the database by entering your password.
+
+## Directory Structure
+
+Data is kept completely separate from the code repo. The application automatically creates the required directories on first run:
+
+```txt
+~/.local/share/cpkb/
+├── snippets.db
+├── attachments/
+├── backups/
+├── exports/
+├── imports/
+└── logs/
+```
+
+## Requirements
+
+- Python 3.11+
+- `textual`
+- `cryptography` (for `encrypt-db` / `decrypt-db`)
+- `fzf` (Optional, for `cpkb fzf`)
+- A platform clipboard helper: `pbcopy` on macOS, `xclip` or `xsel` on Linux, `clip` on Windows
+
+## License
+
+MIT License.

cpkb-2.0.1/README.md

@@ -0,0 +1,135 @@
+# Competitive Programming Knowledge Base (CPKB)
+
+![CPKB TUI Gallery](https://raw.githubusercontent.com/Aaravshah2907/cpkb/main/intro-image.png)
+
+CPKB is a local, terminal-first knowledge base designed to store, search, and track usages of competitive programming snippets, algorithms, and tricks. It uses SQLite for storage, keeping your snippets incredibly fast and perfectly organised.
+
+## Version 2.0 Features
+
+- **Store snippets**: Add code snippets with metadata like title, use case, and tags.
+- **Search snippets**: Full-text search across titles, descriptions, tags, and code.
+- **Track usage**: Record every time you use a snippet in a problem, linking to the file and optionally taking notes.
+- **Textual TUI**: A beautiful terminal UI for browsing and copying your snippets.
+- **FZF Integration**: Fuzzy find snippets directly in the terminal.
+- **Snippet Insertion**: Instantly copy code to the clipboard or append to files.
+- **Spaced Repetition (SM-2)**: Revise your knowledge base using the `revise` command with a true SM-2 spaced-repetition algorithm that tracks ease, interval, and repetitions per snippet.
+- **Password-based Encryption**: Encrypt your database at rest with a password (PBKDF2-HMAC-SHA256 key derivation). No keys stored on disk.
+- **XDG Base Directory compliant**: Stores your data safely in `~/.local/share/cpkb`.
+
+## Installation
+
+Install CPKB with `pipx`:
+
+```bash
+pipx install cpkb
+```
+
+Or install it with `pip`:
+
+```bash
+python -m pip install cpkb
+```
+
+### Homebrew
+
+After the first release is published, macOS and Linux users can install from the project tap:
+
+```bash
+brew tap Aaravshah2907/cpkb
+brew install cpkb
+```
+
+Until the tap is live, the formula template lives in `Formula/cpkb.rb`.
+
+### From Source
+
+```bash
+git clone https://github.com/Aaravshah2907/cpkb.git
+cd cpkb
+pip install -e .
+```
+
+### Local Development & Testing
+
+If you wish to contribute to the codebase or run the unit tests locally to verify the CLI and TUI functionality, set up a virtual environment and run `pytest`:
+
+```bash
+# 1. Create and activate a virtual environment
+python3 -m venv venv
+source venv/bin/activate  # On Windows use: venv\Scripts\activate
+
+# 2. Install CPKB and test dependencies
+python -m pip install -e ".[dev]"
+
+# 3. Run the test suite
+pytest
+```
+
+## Platform‑specific dependencies
+
+| Platform | Clipboard utility   | Fuzzy finder                               |
+|----------|---------------------|--------------------------------------------|
+| macOS    | `pbcopy` (built‑in) | `brew install fzf`                         |
+| Linux    | `xclip` or `xsel`   | `sudo apt-get install fzf`                 |
+| Windows  | `clip` (built‑in)   | `scoop install fzf` or `choco install fzf` |
+
+## Usage
+
+Here are the commands available in Version 2.0:
+
+### Core V1 Commands
+
+- `cpkb add`: Add a new snippet interactively.
+- `cpkb list`: List all snippets.
+- `cpkb show <id>`: Show details, code, and usages of a specific snippet.
+- `cpkb search <query>`: Search for snippets matching multiple words.
+- `cpkb use <id> <file>`: Record the usage of a snippet in a specific file.
+- `cpkb usages <id>`: List all recorded usages for a snippet.
+- `cpkb stats`: Show basic database statistics.
+- `cpkb random`: Show a random snippet for review or practice.
+- `cpkb edit <id>`: Edit a snippet's metadata and code in your default `$EDITOR`.
+- `cpkb edit-usage <id>`: Edit a past usage record.
+- `cpkb delete <id>`: Delete a snippet permanently.
+- `cpkb recent`: Show the 10 most recently added snippets.
+- `cpkb export`: Export your entire knowledge base to a single Markdown file.
+- `cpkb export-db [--encrypted]`: Export your SQLite database, optionally encrypted with a password.
+- `cpkb import <file-or-url>`: Append snippets from a CPKB `db`, `json`, `md`, or `html` export.
+- `cpkb import --defaults`: Import bundled C++ STL competitive-programming cheatsheets with special `cp_` IDs.
+- `cpkb import --list-defaults`: Preview the bundled cheatsheets before importing.
+- `cpkb backup`: Manually trigger a backup of the SQLite database.
+
+### New V2 Commands
+
+- `cpkb tui`: Launch the interactive Textual TUI (press `c` to copy a snippet).
+- `cpkb fzf`: Interactively fuzzy search snippets using `fzf`.
+- `cpkb copy <id> [-f <file>]`: Instantly copy the snippet's code to your system clipboard (uses `pbcopy` on macOS, `xclip`/`xsel` on Linux, `clip` on Windows) or append to a file.
+- `cpkb revise`: Start a spaced-repetition session — the SM-2 algorithm selects the most overdue snippet, shows the title, then reveals the code. Rate your recall (0–5) to schedule the next review.
+- `cpkb srs-stats`: Show spaced-repetition statistics (total reviewed, due now, avg ease factor).
+- `cpkb encrypt-db`: Encrypt the database with a password (PBKDF2 + Fernet). No key files are stored.
+- `cpkb decrypt-db`: Decrypt the database by entering your password.
+
+## Directory Structure
+
+Data is kept completely separate from the code repo. The application automatically creates the required directories on first run:
+
+```txt
+~/.local/share/cpkb/
+├── snippets.db
+├── attachments/
+├── backups/
+├── exports/
+├── imports/
+└── logs/
+```
+
+## Requirements
+
+- Python 3.11+
+- `textual`
+- `cryptography` (for `encrypt-db` / `decrypt-db`)
+- `fzf` (Optional, for `cpkb fzf`)
+- A platform clipboard helper: `pbcopy` on macOS, `xclip` or `xsel` on Linux, `clip` on Windows
+
+## License
+
+MIT License.

cpkb-2.0.1/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cpkb"
+version = "2.0.1"
+authors = [
+  { name="Aarav Shah" },
+]
+description = "A terminal-first Competitive Programming Knowledge Base"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["competitive-programming", "snippets", "knowledge-base", "terminal", "tui"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "textual>=0.47.0",
+    "cryptography>=41.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "pytest-mock>=3.12",
+    "twine>=5.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Aaravshah2907/cpkb"
+Repository = "https://github.com/Aaravshah2907/cpkb"
+Issues = "https://github.com/Aaravshah2907/cpkb/issues"
+Changelog = "https://github.com/Aaravshah2907/cpkb/releases"
+
+[project.scripts]
+cpkb = "cpkb.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

cpkb-2.0.1/setup.cfg

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

cpkb-2.0.1/src/cpkb/__init__.py

@@ -0,0 +1,5 @@
+"""
+CPKB - Competitive Programming Knowledge Base
+"""
+
+__version__ = "2.0.1"