wavemind 2.0.4__tar.gz → 2.1.0__tar.gz

wavemind-2.1.0/CONTRIBUTING.md

@@ -0,0 +1,107 @@
+# Contributing To WaveMind
+
+WaveMind is an early dynamic-memory engine. Contributions are welcome, but the
+project has one strict rule: benchmark and production claims must be
+reproducible.
+
+## Local Setup
+
+```sh
+git clone https://github.com/CaspianG/wavemind.git
+cd wavemind
+python -m pip install -e ".[dev]"
+pytest -q
+```
+
+Optional extras:
+
+```sh
+python -m pip install -e ".[sentence,bench,indexes,postgres]"
+```
+
+Notes:
+
+- `faiss-cpu` is not installed by the `indexes` extra on Windows because the
+  package is not consistently available there.
+- `postgres` installs `psycopg`; it still requires a running PostgreSQL
+  database with the pgvector extension available.
+- Benchmark dependencies such as Chroma and Qdrant are intentionally optional.
+- Public datasets are not downloaded by default.
+
+## Good First Areas
+
+- Documentation examples for real applications and frameworks.
+- Benchmark adapters that produce checked-in JSON output.
+- Small tests around TTL, namespaces, corrections, and graph behavior.
+- Production hardening around auth, rate limits, metrics, backups, and sharding.
+- Import/export tools.
+- CLI and FastAPI ergonomics.
+
+## Benchmark Rules
+
+Do not add a README claim unless it has:
+
+- a reproducible command;
+- a checked-in JSON result under `benchmarks/`;
+- the dataset name and size;
+- the encoder used;
+- the compared engines;
+- latency and quality metrics;
+- a limitation note when the result is retrieval-only, synthetic, local-mode, or
+  not leaderboard-equivalent.
+
+It is acceptable to add planned benchmark rows, but they must be marked as
+planned and must not be phrased as wins.
+
+## Development Checks
+
+Before opening a PR, run:
+
+```sh
+pytest -q
+python -m build
+python -m twine check dist/*
+```
+
+On Windows PowerShell:
+
+```powershell
+pytest -q
+python -m build
+python -m twine check dist\*
+```
+
+## Architecture Direction
+
+WaveMind should stay local-first by default:
+
+- SQLite remains the default source of truth.
+- Vector indexes generate candidates.
+- WaveMind applies memory-specific reranking on the candidate window.
+- No backend should silently replace another backend. If an optional dependency
+  is missing, raise a clear error or mark the benchmark row as skipped.
+
+Current scale roadmap:
+
+- FAISS candidate index.
+- Postgres + pgvector prototype.
+- Service-mode Qdrant benchmark.
+- Faster dynamic reranking.
+- Background jobs for decay, consolidation, graph updates, and backups.
+- Observability through metrics, traces, and audit logs.
+
+See [`docs/ROADMAP.md`](docs/ROADMAP.md) for the full roadmap.
+See [`docs/RELEASE.md`](docs/RELEASE.md) for release mechanics.
+
+## Pull Request Style
+
+Keep PRs focused. A good PR usually changes one of:
+
+- one backend;
+- one benchmark;
+- one integration;
+- one documentation section;
+- one bug fix with tests.
+
+If a change affects benchmark numbers, update both the result JSON and the
+README/report text that cites it.

wavemind-2.1.0/Dockerfile

@@ -0,0 +1,23 @@
+FROM python:3.11-slim
+
+ARG INSTALL_OPTIONAL=false
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+ENV WAVEMIND_DB=/data/wavemind.sqlite3
+ENV WAVEMIND_LOG_LEVEL=INFO
+
+WORKDIR /app
+
+COPY README.md pyproject.toml requirements.txt requirements-optional.txt ./
+RUN pip install --no-cache-dir -r requirements.txt \
+    && if [ "$INSTALL_OPTIONAL" = "true" ]; then pip install --no-cache-dir -r requirements-optional.txt; fi
+
+COPY wavemind ./wavemind
+COPY wavemind_v2.py ./wavemind_v2.py
+RUN pip install --no-cache-dir -e .
+
+VOLUME ["/data", "/backups"]
+EXPOSE 8000
+
+CMD ["uvicorn", "wavemind.api:create_app", "--factory", "--host", "0.0.0.0", "--port", "8000"]

wavemind-2.1.0/MANIFEST.in

@@ -0,0 +1,20 @@
+include README.md
+include LICENSE
+include CONTRIBUTING.md
+include SECURITY.md
+include SUPPORT.md
+include install.sh
+include install.bat
+include Dockerfile
+include docker-compose.yml
+include requirements.txt
+include requirements-optional.txt
+include docs/ROADMAP.md
+include docs/RELEASE.md
+include docs/PROJECT_BOARD.md
+include docs/assets/benchmark-summary.svg
+include benchmarks/*.py
+include benchmarks/*.json
+include benchmarks/*.md
+include examples/*.py
+prune benchmarks/data