fromscratch-pydb 0.5.0__tar.gz

fromscratch_pydb-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    uses: robcox2910/robcox2910.github.io/.github/workflows/python-ci.yml@v1

fromscratch_pydb-0.5.0/.github/workflows/docs.yml

@@ -0,0 +1,16 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  docs:
+    uses: robcox2910/robcox2910.github.io/.github/workflows/docs.yml@v1
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      coverage-report: false

fromscratch_pydb-0.5.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          files: dist/*
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/fromscratch-pydb/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fromscratch_pydb-0.5.0/.gitignore

@@ -0,0 +1,42 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.hypothesis/
+htmlcov/
+.coverage
+.coverage.*
+
+# Type checking
+.pyright/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Version file (generated)
+src/pydb/_version.py
+
+# MkDocs
+site/
+.superpowers/

fromscratch_pydb-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+default_language_version:
+  python: python3.14
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Pages paste real pytest output, trailing spaces included.
+      - id: trailing-whitespace
+        exclude: ^docs/property-testing\.md$
+      - id: end-of-file-fixer
+        exclude: ^docs/property-testing\.md$
+      - id: check-yaml
+        args: ['--unsafe']
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.408
+    hooks:
+      - id: pyright
+
+  - repo: local
+    hooks:
+      - id: pip-audit
+        name: pip-audit
+        language: system
+        pass_filenames: false
+        files: ^(pyproject\.toml|uv\.lock)$
+        entry: >-
+          bash -c 'f=$(mktemp) &&
+          uv export --frozen --no-emit-project --all-extras --no-hashes -o "$f" >/dev/null &&
+          uvx pip-audit==2.10.0 -r "$f" --disable-pip --no-deps;
+          status=$?; rm -f "$f"; exit $status'
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.13.8
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+        additional_dependencies: [typing_extensions]

fromscratch_pydb-0.5.0/CLAUDE.md

@@ -0,0 +1,56 @@
+# Claude Code Instructions
+
+<!-- standard:start -->
+## Code Style
+
+- All public functions, methods, classes, and modules **must** have a docstring
+- Use imperative mood: "Return the result." not "Returns the result."
+- One-line docstrings for simple functions; multi-line with summary + details for complex ones
+- Follow the Google docstring convention (D211, D212 selected via ruff)
+
+## Linting
+
+- Ruff enforces a comprehensive rule set -- run `uv run ruff check .` before committing
+- Pyright runs in strict mode -- run `uv run pyright src tests` before committing
+- All violations must be fixed, not ignored. Exceptions are the repo-owned `ignore` and `per-file-ignores` lists in `pyproject.toml`, which belong to this repo; the series sync never edits them
+
+## Testing
+
+- TDD workflow: Red-Green-Refactor
+- Coverage is enforced by pytest-cov; the floor in `pyproject.toml` is repo-owned
+- Test classes and methods also require docstrings
+- Use named constants instead of magic values (PLR2004)
+- Run `uv run pytest` before committing
+- Property-based tests (Hypothesis) live in `tests/test_properties.py` and `tests/test_model.py`; the shared profiles are in the root `conftest.py` (owned by `series sync`). Run `uv run pytest --hypothesis-profile=thorough` before a release.
+
+## Commits
+
+- Use conventional commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `ci:`, `chore:`
+- All changes go via PR from a feature branch (main is protected); merge when CI is green
+
+## Dependencies
+
+- Package manager: uv
+- Run `uv sync --all-extras` after modifying dependencies
+- `uv.lock` is committed; CI and pre-commit audit it with pip-audit through `uvx`, so pip-audit is not a project dependency
+- Sibling projects, where used, are pinned release tags in `[tool.uv.sources]` (git + tag); never use `path` sources
+
+## Releasing
+
+- A release is a `vX.Y.Z` tag on main after the PR is merged
+- Docs-only and tooling-only changes do not get a release tag
+- Docs are built with `mkdocs build --strict` and deployed to GitHub Pages by the docs workflow
+<!-- standard:end -->
+
+## Project notes
+
+- Use imperative mood: "Return the record." not "Returns the record."
+- Pyright in strict mode -- run `uv run pyright src tests` before committing
+- All violations must be fixed, not ignored (except D203/D213 incompatible pair)
+- Inline `# noqa:` is acceptable only when tools genuinely conflict (e.g., ARG002 vs pyright protocol parameter names, PLW0108 for typed default_factory lambdas)
+- Minimum 80% coverage enforced by pytest-cov
+- Use conventional commits (enforced by commitizen): `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `ci:`, `chore:`
+- All changes go via PR from a feature branch (main is protected)
+- Pre-commit hooks must pass: ruff, ruff-format, pyright, pip-audit
+- Add production deps to `[project.dependencies]`
+- Add dev deps to `[project.optional-dependencies.dev]` or `[dependency-groups.dev]`

fromscratch_pydb-0.5.0/CONTRIBUTING.md

@@ -0,0 +1,195 @@
+# Contributing to PyDB
+
+Thanks for your interest in contributing! This guide covers everything you need
+to get started.
+
+## Prerequisites
+
+| Tool | Version | Install |
+|------|---------|---------|
+| Python | 3.14+ | [python.org](https://www.python.org/downloads/) |
+| uv | latest | `curl -LsSf https://astral.sh/uv/install.sh \| sh` |
+| git | 2.x+ | [git-scm.com](https://git-scm.com/) |
+
+## Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/robcox2910/pydb.git
+cd pydb
+
+# Install all dependencies (including dev tools)
+uv sync --all-extras
+
+# Install pre-commit hooks (linting + commit message validation)
+uv run pre-commit install
+uv run pre-commit install --hook-type commit-msg
+```
+
+Verify everything works:
+
+```bash
+uv run pytest --cov          # tests pass, >= 80% coverage
+uv run ruff check src/ tests/  # no lint errors
+uv run pyright src tests       # no type errors
+```
+
+## TDD Workflow
+
+We follow **Red-Green-Refactor** for every code change:
+
+1. **Red** -- Write a failing test that describes the behaviour you want.
+2. **Green** -- Write the simplest code that makes the test pass.
+3. **Refactor** -- Clean up while keeping all tests green.
+
+Never skip the red step. If you can't write a failing test first, take a moment
+to think about what the code should actually do.
+
+## Branch Naming
+
+Create a branch from `main` using one of these prefixes:
+
+| Prefix | When to use |
+|--------|-------------|
+| `feat/` | New feature or database component |
+| `fix/` | Bug fix |
+| `refactor/` | Restructuring without behaviour change |
+| `test/` | Test-only changes |
+| `docs/` | Documentation updates |
+| `ci/` | CI/CD workflow changes |
+| `chore/` | Dependency bumps, config tweaks |
+
+Example: `feat/schema`, `fix/insert-validation`
+
+## Conventional Commits
+
+Every commit message must follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<type>: <short description in imperative mood>
+
+Optional longer explanation.
+```
+
+Types match the branch prefixes: `feat:`, `fix:`, `refactor:`, `test:`,
+`docs:`, `ci:`, `chore:`.
+
+Good examples:
+
+```
+feat: add schema with column definitions
+fix: reject null values in non-nullable columns
+docs: add storage engine concept page
+```
+
+Bad examples:
+
+```
+updated stuff          # no type, vague description
+feat: adds schema      # not imperative mood ("adds" -> "add")
+```
+
+## Code Style
+
+### Modern Python
+
+Use Python 3.14 idioms everywhere:
+
+- `X | Y` for union types (not `Union[X, Y]` or `Optional[X]`)
+- `StrEnum` for string enumerations
+- `match/case` instead of if/elif chains where appropriate
+- Direct imports: `from enum import StrEnum` not `import enum`
+
+### Docstrings
+
+Every public function, method, class, and module needs a docstring:
+
+- Use **imperative mood**: "Return the record." not "Returns the record."
+- One-liner for simple functions, multi-line (Google style) for complex ones.
+
+```python
+def find_by_id(self, record_id: int) -> Record:
+    """Return the record with the given ID."""
+
+def insert(self, values: dict[str, Value]) -> Record:
+    """Insert a new record into the table.
+
+    Args:
+        values: Column-name-to-value mapping for the new record.
+
+    Returns:
+        The newly created record with an assigned ID.
+
+    Raises:
+        SchemaError: If values don't match the table's schema.
+    """
+```
+
+### Named Constants
+
+Use named constants instead of magic numbers in tests and source code. Ruff
+rule PLR2004 enforces this.
+
+```python
+# Good
+EXPECTED_ROW_COUNT = 5
+assert len(results) == EXPECTED_ROW_COUNT
+
+# Bad
+assert len(results) == 5
+```
+
+## Linting and Type Checking
+
+Run these before every commit (pre-commit hooks enforce them automatically):
+
+```bash
+uv run ruff check src/ tests/   # lint
+uv run ruff format src/ tests/   # format (or --check to verify)
+uv run pyright src tests          # type check (strict mode)
+```
+
+Fix all violations. Inline `# noqa:` is acceptable only when tools genuinely
+conflict (e.g., ARG002 vs pyright protocol parameter names).
+
+## Testing
+
+```bash
+uv run pytest                # run all tests
+uv run pytest --cov          # with coverage report
+uv run pytest tests/test_x.py  # run a specific file
+uv run pytest -k "test_name"   # run tests matching a pattern
+```
+
+- Minimum **80% coverage** is enforced.
+- Test classes and methods need docstrings too.
+- Use `pytest.raises` as a context manager for exception testing.
+
+## Documentation Style
+
+Our docs target a **12-year-old with an interest in computing**. Keep language
+simple, use analogies, and avoid jargon without explanation.
+
+Good:
+
+> A table is like a spreadsheet. Each row is one thing (a person, a book, a
+> score), and each column is one fact about that thing (name, title, points).
+
+Bad:
+
+> A table is a relation comprising a set of tuples over a fixed schema of
+> typed attributes conforming to first normal form.
+
+## Pull Request Process
+
+1. Create a feature branch from `main`.
+2. Make your changes following TDD.
+3. Ensure all checks pass: `uv run ruff check .`, `uv run pyright src tests`,
+   `uv run pytest --cov`.
+4. Push your branch and open a PR against `main`.
+5. PRs are squash-merged to keep history clean.
+
+## Questions?
+
+Open an issue on [GitHub](https://github.com/robcox2910/pydb/issues) --
+we're happy to help!

fromscratch_pydb-0.5.0/LICENSE

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