fromscratch-pygraphdb 0.4.0__tar.gz

fromscratch_pygraphdb-0.4.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_pygraphdb-0.4.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_pygraphdb-0.4.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-pygraphdb/
+    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_pygraphdb-0.4.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+dist/
+build/
+.coverage
+htmlcov/
+.ruff_cache/
+_version.py
+.hypothesis/

fromscratch_pygraphdb-0.4.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_pygraphdb-0.4.0/CLAUDE.md

@@ -0,0 +1,52 @@
+# 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
+
+- Pyright in strict mode -- run `uv run pyright src tests` before committing
+- All violations must be fixed, not ignored (except D203/D213 incompatible pair)
+- 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)
+- Add production deps to `[project.dependencies]`

fromscratch_pygraphdb-0.4.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.

fromscratch_pygraphdb-0.4.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.5
+Name: fromscratch-pygraphdb
+Version: 0.4.0
+Summary: An educational graph database library built from scratch in Python
+Project-URL: Homepage, https://github.com/robcox2910/pygraphdb
+Project-URL: Repository, https://github.com/robcox2910/pygraphdb
+Project-URL: Issues, https://github.com/robcox2910/pygraphdb/issues
+Project-URL: Documentation, https://robcox2910.github.io/pygraphdb/
+Author: Rob Cox
+License: MIT
+License-File: LICENSE
+Keywords: database,education,graph,neo4j
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Provides-Extra: dev
+Requires-Dist: commitizen>=4.4.0; extra == 'dev'
+Requires-Dist: hypothesis>=6.170; extra == 'dev'
+Requires-Dist: pip-audit>=2.10.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0.1; extra == 'dev'
+Requires-Dist: pyright>=1.1.400; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.4; extra == 'dev'
+Requires-Dist: ruff>=0.9.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# PyGraphDB
+
+An educational graph database library built from scratch in Python. Part of the **PyLearn** educational platform for kids aged 12+.
+
+A graph database stores data as **nodes** (entities) and **edges** (relationships) -- like a social network map where people are dots and friendships are lines connecting them.
+
+## Features
+
+- **Nodes & Edges** -- Create entities with labels and properties, connect them with typed relationships
+- **CRUD Operations** -- Add, get, update, and delete nodes and edges
+- **Graph Traversal** -- Explore your graph with BFS (breadth-first) and DFS (depth-first) algorithms
+- **Shortest Path** -- Find the quickest route between two nodes (like GPS directions)
+- **Pattern Matching** -- Search for nodes and edges by label, type, or properties
+- **Cypher-like Queries** -- Ask questions with a simple query language inspired by Neo4j's Cypher
+- **Persistence** -- Save and load your graph to/from JSON files
+- **Neighbor & Degree** -- Find connected nodes and count connections
+
+## Quick Start
+
+```python
+from pygraphdb import Graph, bfs, shortest_path, execute_query, find_nodes
+
+# Create a social network
+g = Graph()
+g.add_node("alice", label="Person", properties={"name": "Alice", "age": 13})
+g.add_node("bob", label="Person", properties={"name": "Bob", "age": 14})
+g.add_node("charlie", label="Person", properties={"name": "Charlie", "age": 13})
+
+g.add_edge("e1", "alice", "bob", rel_type="KNOWS")
+g.add_edge("e2", "bob", "charlie", rel_type="KNOWS")
+
+# Find Alice's friends
+friends = g.get_neighbors("alice", direction="outgoing")
+print([f.properties["name"] for f in friends])  # ['Bob']
+
+# Traverse the whole network
+visited = bfs(g, "alice")
+print([n.properties["name"] for n in visited])  # ['Alice', 'Bob', 'Charlie']
+
+# Find shortest path
+path = shortest_path(g, "alice", "charlie")
+print([n.properties["name"] for n in path])  # ['Alice', 'Bob', 'Charlie']
+
+# Query with Cypher-like syntax
+results = execute_query(g, 'MATCH (n:Person) WHERE n.name = "Alice" RETURN n')
+print(results[0].properties["name"])  # 'Alice'
+
+# Pattern matching
+teenagers = find_nodes(g, label="Person")
+print(len(teenagers))  # 3
+```
+
+## Installation
+
+```bash
+# Clone and install
+git clone https://github.com/robcox2910/pygraphdb.git
+cd pygraphdb
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Lint & type check
+uv run ruff check src/ tests/
+uv run pyright src tests
+```
+
+## Releasing
+
+Other projects in the series ([PyStack](https://github.com/robcox2910/pystack)) use a pinned release of this one,
+not whatever is on `main`. To publish a change for them:
+
+1. Merge the change to `main`.
+2. Tag it: `git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z`.
+   A change to the public API bumps the minor version (`v0.1.0` → `v0.2.0`);
+   anything else bumps the patch (`v0.1.0` → `v0.1.1`).
+3. In each project that uses it, edit the tag in `[tool.uv.sources]`, run
+   `uv lock --upgrade-package <name>`, and open a pull request so CI checks
+   the pair together.
+
+<!-- series:start -->
+## Related Projects
+
+This project is one of a series that builds real systems "from scratch in Python" to teach how they work. See the [series home](https://robcox2910.github.io/) for the full story.
+
+| Project | What it teaches | Repository | Docs |
+| --- | --- | --- | --- |
+| PyOS | Operating systems | [py-os](https://github.com/robcox2910/py-os) | [Docs](https://robcox2910.github.io/py-os/) |
+| Pebble | Compilers and programming languages | [pebble-lang](https://github.com/robcox2910/pebble-lang) | [Docs](https://robcox2910.github.io/pebble-lang/) |
+| PyDB | Relational databases | [pydb](https://github.com/robcox2910/pydb) | [Docs](https://robcox2910.github.io/pydb/) |
+| PyKV | Key-value stores | [pykv](https://github.com/robcox2910/pykv) | [Docs](https://robcox2910.github.io/pykv/) |
+| PyDocDB | Document databases | [pydoc-db](https://github.com/robcox2910/pydoc-db) | [Docs](https://robcox2910.github.io/pydoc-db/) |
+| **PyGraphDB** | **Graph databases** | [pygraphdb](https://github.com/robcox2910/pygraphdb) | [Docs](https://robcox2910.github.io/pygraphdb/) |
+| PyTSDB | Time-series databases | [pytsdb](https://github.com/robcox2910/pytsdb) | [Docs](https://robcox2910.github.io/pytsdb/) |
+| PyVecDB | Vector databases | [pyvecdb](https://github.com/robcox2910/pyvecdb) | [Docs](https://robcox2910.github.io/pyvecdb/) |
+| PyColDB | Column-family databases | [pycoldb](https://github.com/robcox2910/pycoldb) | [Docs](https://robcox2910.github.io/pycoldb/) |
+| PyCrypt | Cryptography | [pycrypt](https://github.com/robcox2910/pycrypt) | [Docs](https://robcox2910.github.io/pycrypt/) |
+| PyNet | Computer networking | [pynet](https://github.com/robcox2910/pynet) | [Docs](https://robcox2910.github.io/pynet/) |
+| PyWeb | HTTP web servers | [pyweb](https://github.com/robcox2910/pyweb) | [Docs](https://robcox2910.github.io/pyweb/) |
+| PyGit | Version control | [pygit](https://github.com/robcox2910/pygit) | [Docs](https://robcox2910.github.io/pygit/) |
+| PySearch | Search engines | [pysearch](https://github.com/robcox2910/pysearch) | [Docs](https://robcox2910.github.io/pysearch/) |
+| PyMQ | Message queues | [pymq](https://github.com/robcox2910/pymq) | [Docs](https://robcox2910.github.io/pymq/) |
+| PyLLM | Language models (the brain) | [pyllm](https://github.com/robcox2910/pyllm) | [Docs](https://robcox2910.github.io/pyllm/) |
+| PyScheduler | Job scheduling | [pyscheduler](https://github.com/robcox2910/pyscheduler) | [Docs](https://robcox2910.github.io/pyscheduler/) |
+| PyStack | Full-stack integration | [pystack](https://github.com/robcox2910/pystack) | [Docs](https://robcox2910.github.io/pystack/) |
+<!-- series:end -->
+
+<!-- docs:start -->
+## Documentation
+
+Full docs (with kid-friendly explanations of every idea): https://robcox2910.github.io/pygraphdb/
+<!-- docs:end -->

fromscratch_pygraphdb-0.4.0/README.md

@@ -0,0 +1,113 @@
+# PyGraphDB
+
+An educational graph database library built from scratch in Python. Part of the **PyLearn** educational platform for kids aged 12+.
+
+A graph database stores data as **nodes** (entities) and **edges** (relationships) -- like a social network map where people are dots and friendships are lines connecting them.
+
+## Features
+
+- **Nodes & Edges** -- Create entities with labels and properties, connect them with typed relationships
+- **CRUD Operations** -- Add, get, update, and delete nodes and edges
+- **Graph Traversal** -- Explore your graph with BFS (breadth-first) and DFS (depth-first) algorithms
+- **Shortest Path** -- Find the quickest route between two nodes (like GPS directions)
+- **Pattern Matching** -- Search for nodes and edges by label, type, or properties
+- **Cypher-like Queries** -- Ask questions with a simple query language inspired by Neo4j's Cypher
+- **Persistence** -- Save and load your graph to/from JSON files
+- **Neighbor & Degree** -- Find connected nodes and count connections
+
+## Quick Start
+
+```python
+from pygraphdb import Graph, bfs, shortest_path, execute_query, find_nodes
+
+# Create a social network
+g = Graph()
+g.add_node("alice", label="Person", properties={"name": "Alice", "age": 13})
+g.add_node("bob", label="Person", properties={"name": "Bob", "age": 14})
+g.add_node("charlie", label="Person", properties={"name": "Charlie", "age": 13})
+
+g.add_edge("e1", "alice", "bob", rel_type="KNOWS")
+g.add_edge("e2", "bob", "charlie", rel_type="KNOWS")
+
+# Find Alice's friends
+friends = g.get_neighbors("alice", direction="outgoing")
+print([f.properties["name"] for f in friends])  # ['Bob']
+
+# Traverse the whole network
+visited = bfs(g, "alice")
+print([n.properties["name"] for n in visited])  # ['Alice', 'Bob', 'Charlie']
+
+# Find shortest path
+path = shortest_path(g, "alice", "charlie")
+print([n.properties["name"] for n in path])  # ['Alice', 'Bob', 'Charlie']
+
+# Query with Cypher-like syntax
+results = execute_query(g, 'MATCH (n:Person) WHERE n.name = "Alice" RETURN n')
+print(results[0].properties["name"])  # 'Alice'
+
+# Pattern matching
+teenagers = find_nodes(g, label="Person")
+print(len(teenagers))  # 3
+```
+
+## Installation
+
+```bash
+# Clone and install
+git clone https://github.com/robcox2910/pygraphdb.git
+cd pygraphdb
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Lint & type check
+uv run ruff check src/ tests/
+uv run pyright src tests
+```
+
+## Releasing
+
+Other projects in the series ([PyStack](https://github.com/robcox2910/pystack)) use a pinned release of this one,
+not whatever is on `main`. To publish a change for them:
+
+1. Merge the change to `main`.
+2. Tag it: `git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z`.
+   A change to the public API bumps the minor version (`v0.1.0` → `v0.2.0`);
+   anything else bumps the patch (`v0.1.0` → `v0.1.1`).
+3. In each project that uses it, edit the tag in `[tool.uv.sources]`, run
+   `uv lock --upgrade-package <name>`, and open a pull request so CI checks
+   the pair together.
+
+<!-- series:start -->
+## Related Projects
+
+This project is one of a series that builds real systems "from scratch in Python" to teach how they work. See the [series home](https://robcox2910.github.io/) for the full story.
+
+| Project | What it teaches | Repository | Docs |
+| --- | --- | --- | --- |
+| PyOS | Operating systems | [py-os](https://github.com/robcox2910/py-os) | [Docs](https://robcox2910.github.io/py-os/) |
+| Pebble | Compilers and programming languages | [pebble-lang](https://github.com/robcox2910/pebble-lang) | [Docs](https://robcox2910.github.io/pebble-lang/) |
+| PyDB | Relational databases | [pydb](https://github.com/robcox2910/pydb) | [Docs](https://robcox2910.github.io/pydb/) |
+| PyKV | Key-value stores | [pykv](https://github.com/robcox2910/pykv) | [Docs](https://robcox2910.github.io/pykv/) |
+| PyDocDB | Document databases | [pydoc-db](https://github.com/robcox2910/pydoc-db) | [Docs](https://robcox2910.github.io/pydoc-db/) |
+| **PyGraphDB** | **Graph databases** | [pygraphdb](https://github.com/robcox2910/pygraphdb) | [Docs](https://robcox2910.github.io/pygraphdb/) |
+| PyTSDB | Time-series databases | [pytsdb](https://github.com/robcox2910/pytsdb) | [Docs](https://robcox2910.github.io/pytsdb/) |
+| PyVecDB | Vector databases | [pyvecdb](https://github.com/robcox2910/pyvecdb) | [Docs](https://robcox2910.github.io/pyvecdb/) |
+| PyColDB | Column-family databases | [pycoldb](https://github.com/robcox2910/pycoldb) | [Docs](https://robcox2910.github.io/pycoldb/) |
+| PyCrypt | Cryptography | [pycrypt](https://github.com/robcox2910/pycrypt) | [Docs](https://robcox2910.github.io/pycrypt/) |
+| PyNet | Computer networking | [pynet](https://github.com/robcox2910/pynet) | [Docs](https://robcox2910.github.io/pynet/) |
+| PyWeb | HTTP web servers | [pyweb](https://github.com/robcox2910/pyweb) | [Docs](https://robcox2910.github.io/pyweb/) |
+| PyGit | Version control | [pygit](https://github.com/robcox2910/pygit) | [Docs](https://robcox2910.github.io/pygit/) |
+| PySearch | Search engines | [pysearch](https://github.com/robcox2910/pysearch) | [Docs](https://robcox2910.github.io/pysearch/) |
+| PyMQ | Message queues | [pymq](https://github.com/robcox2910/pymq) | [Docs](https://robcox2910.github.io/pymq/) |
+| PyLLM | Language models (the brain) | [pyllm](https://github.com/robcox2910/pyllm) | [Docs](https://robcox2910.github.io/pyllm/) |
+| PyScheduler | Job scheduling | [pyscheduler](https://github.com/robcox2910/pyscheduler) | [Docs](https://robcox2910.github.io/pyscheduler/) |
+| PyStack | Full-stack integration | [pystack](https://github.com/robcox2910/pystack) | [Docs](https://robcox2910.github.io/pystack/) |
+<!-- series:end -->
+
+<!-- docs:start -->
+## Documentation
+
+Full docs (with kid-friendly explanations of every idea): https://robcox2910.github.io/pygraphdb/
+<!-- docs:end -->

fromscratch_pygraphdb-0.4.0/conftest.py

@@ -0,0 +1,21 @@
+"""Shared Hypothesis profiles for the series.
+
+Two profiles are registered, and ``ci`` is loaded by default:
+
+- ``ci`` runs 100 examples with no deadline, a fixed seed and no example
+  database, so the same code gives the same result on every machine and a
+  green build can be trusted.
+- ``thorough`` runs 2000 examples with a random seed, to hunt for the rare
+  counterexample before a release.
+
+Run the long one with ``uv run pytest --hypothesis-profile=thorough``.
+
+This file is owned by ``series sync``. Edit it in the series home repo
+(robcox2910.github.io), not here, or the next sync will put it back.
+"""
+
+from hypothesis import settings
+
+settings.register_profile("ci", max_examples=100, deadline=None, derandomize=True, database=None)
+settings.register_profile("thorough", max_examples=2000, deadline=None, derandomize=False)
+settings.load_profile("ci")

fromscratch_pygraphdb-0.4.0/docs/concepts/edges.md

@@ -0,0 +1,52 @@
+# Edges -- Friendships and Handshakes
+
+## The Analogy
+
+At our party, people don't just stand around alone -- they interact! When Alice shakes hands with Bob, that handshake is an **edge**. It connects two people and describes their relationship.
+
+An edge has:
+- A **direction**: Alice shook Bob's hand (Alice -> Bob). This is a *directed* edge, like a one-way street.
+- A **type**: What kind of relationship? "FRIENDS_WITH", "CLASSMATES", "SIBLINGS"
+- **Properties**: Extra details -- "became friends in 2023", "best friends" vs "acquaintances"
+
+```python
+from pygraphdb import Graph
+
+g = Graph()
+g.add_node("alice", label="Student", properties={"name": "Alice"})
+g.add_node("bob", label="Student", properties={"name": "Bob"})
+
+# The handshake!
+g.add_edge("e1", "alice", "bob", rel_type="FRIENDS_WITH", properties={"since": 2023})
+```
+
+## Direction Matters
+
+Our edges are **directed** -- like arrows, not lines. "Alice FOLLOWS Bob" doesn't mean "Bob FOLLOWS Alice." If you want a mutual friendship, you need two edges:
+
+```python
+g.add_edge("e1", "alice", "bob", rel_type="FRIENDS_WITH")
+g.add_edge("e2", "bob", "alice", rel_type="FRIENDS_WITH")
+```
+
+## Multiple Relationships
+
+Two nodes can have multiple edges between them! Alice might KNOW Bob (they've met) AND WORK_WITH Bob (they're lab partners). Each relationship is a separate edge with its own type and properties.
+
+## Every Node Keeps Its Own Address Book
+
+How do you find someone's friends? The slow way is to read *every*
+friendship in the whole school and pick out the ones that mention them.
+That gets slower and slower as the school grows.
+
+PyGraphDB does it the fast way: every node keeps its own little **address
+book** -- one list of the edges going out from it and one list of the edges
+coming in. Asking "who are Alice's friends?" just opens Alice's address book.
+It doesn't matter if the school has ten friendships or ten million; it's
+just as quick.
+
+Real graph databases (like Neo4j) call this **index-free adjacency**, and
+it's the whole reason they're good at following connections. Every time an
+edge is added or removed, both end nodes' address books are updated, so they
+never get out of step. Neighbours come back in the order their edges were
+added, so you get the same answer every time.

fromscratch_pygraphdb-0.4.0/docs/concepts/matching.md

@@ -0,0 +1,52 @@
+# Pattern Matching -- Finding Friends Who Like Pizza
+
+## The Analogy
+
+Imagine you're at a huge party with 200 people. You want to find everyone who:
+- Is a Student (not a Teacher or Parent)
+- Likes pizza
+- Is over 12 years old
+
+You could walk up to every single person and ask... or you could use **pattern matching** to filter everyone instantly!
+
+## How It Works
+
+Pattern matching lets you search through your graph for nodes or edges that match specific criteria:
+
+```python
+from pygraphdb import Graph, find_nodes, find_edges
+
+g = Graph()
+g.add_node("1", label="Person", properties={"name": "Alice", "age": 13, "likes": "pizza"})
+g.add_node("2", label="Person", properties={"name": "Bob", "age": 14, "likes": "tacos"})
+g.add_node("3", label="Person", properties={"name": "Charlie", "age": 13, "likes": "pizza"})
+
+# Find all pizza lovers
+pizza_fans = find_nodes(g, properties={"likes": "pizza"})
+# Result: Alice and Charlie
+
+# Find all people (by label)
+people = find_nodes(g, label="Person")
+# Result: Alice, Bob, and Charlie
+```
+
+## Matching Edges Too
+
+You can also search for specific relationships:
+
+```python
+# Find all FRIENDS_WITH relationships
+friendships = find_edges(g, rel_type="FRIENDS_WITH")
+
+# Find all edges from Alice
+alice_connections = find_edges(g, source_id="1")
+```
+
+## Combining Criteria
+
+The real power comes from combining label AND property filters:
+
+```python
+# Find 13-year-old people who like pizza
+young_pizza_fans = find_nodes(g, label="Person", properties={"age": 13, "likes": "pizza"})
+```

fromscratch_pygraphdb-0.4.0/docs/concepts/nodes.md

@@ -0,0 +1,42 @@
+# Nodes -- People at a Party
+
+## The Analogy
+
+Imagine you're at a big party. Every person there is a **node**. Each person has:
+- A **wristband number** (their unique ID -- no two people share one)
+- A **group name tag** that says what kind of person they are: "Student", "Teacher", "Parent"
+- A **fact sheet** with details about them: their name, age, favorite food, etc.
+
+In our graph database, a Node works exactly the same way:
+
+```python
+from pygraphdb import Node
+
+# Create a person at the party
+alice = Node(
+    node_id="alice-01",      # Wristband number
+    label="Student",          # Group name tag
+    properties={              # Fact sheet
+        "name": "Alice",
+        "age": 13,
+        "favorite_food": "pizza"
+    }
+)
+```
+
+## Why Nodes Need Unique IDs
+
+If two people at the party both had wristband #42, how would you tell them apart when someone says "bring me person #42"? You couldn't! That's why every node needs a unique ID.
+
+## Labels are Like Categories
+
+Labels help you organize nodes into groups. At a school, you might have:
+- `Student` nodes
+- `Teacher` nodes
+- `Classroom` nodes
+
+This makes it easy to ask questions like "show me all the Students."
+
+## Properties are Flexible
+
+Unlike a rigid spreadsheet where every row must have the same columns, node properties are flexible. One Student might have a `gpa` property while another doesn't -- and that's perfectly fine!