oaken-core 0.1.0__tar.gz

oaken_core-0.1.0/.gitignore

@@ -0,0 +1,241 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# --- Oaken Mail: never commit data, mail or secrets ---
+*.db
+*.db-*
+*.sqlite*
+*.eml
+*.mbox
+.env.*
+!.env.example
+token*.json
+credentials*.json
+client_secret*.json
+node_modules/
+site/
+.claude/settings.local.json
+
+# Synthetic test fixtures are committed (no real mail; see docs/architecture/parsing.md).
+!src/oaken/mail/tests/fixtures/**/*.eml
+
+# A real config.toml holds local settings and must never be committed (use config.example.toml).
+config.toml

oaken_core-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.5
+Name: oaken-core
+Version: 0.1.0
+Summary: Oaken Core — the ingestion & enrichment pipeline, the CLI, and the MCP server, so an AI can work with your mail.
+Project-URL: Homepage, https://dfoulks1.github.io/oaken-mail/
+Project-URL: Source, https://github.com/dfoulks1/oaken-mail
+License-Expression: Apache-2.0
+Keywords: ai,email,llm,local-first,mail,mcp,mua,oaken,rag
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Communications :: Email :: Email Clients (MUA)
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: oaken-cli==0.1.0
+Requires-Dist: oaken[vec]==0.1.0
+Description-Content-Type: text/markdown
+
+# Oaken Core
+
+**Oaken Core** is the ingestion & enrichment pipeline, the CLI, and the MCP server — the product
+that lets an AI work with your mail, locally, with nothing leaving your machine unless you
+configure it to.
+
+Installing this bundle gives you the whole non-UI product:
+
+- the **pipeline**: mail is pulled to local disk, filtered by your Sieve rules, parsed, indexed
+  (keyword + vectors) and enriched (summary, triage, actions, header/MIME inspector) by a local
+  model at ingest time, so search and question-answering are cheap in tokens;
+- the local **API daemon** on `127.0.0.1` and the read-only `/stats` status page;
+- the **MCP server** (`/mcp`) — the AI-facing surface, so a stronger model can analyse and act on
+  your mail through a narrow, audited, confirm-gated door while the mail stays on your machine;
+- the **`oaken` command line** to start, configure and drive it (`oaken start`, `oaken auth`,
+  `oaken sync`, `oaken search`, `oaken ask`, `oaken pipeline`, `oaken mcp`, …);
+- the first-party plugins: Gmail, IMAP, SMTP, Ollama, the enrichers, and the sqlite-vec store.
+
+```bash
+pip install oaken-core
+```
+
+The web UI is a **separate product**, built on the same API and CLI framework — install it on its
+own with `pip install oaken-webui`. Other front-ends (desktop, mobile) are anticipated and are
+likewise separate products that build on Oaken Core's HTTP API and MCP surfaces. See
+[ADR 0014](../../docs/adr/0014-product-family-and-ui-surfaces.md) for the product family and the
+surfaces a UI builds on.
+
+License: Apache-2.0.

oaken_core-0.1.0/README.md

@@ -0,0 +1,29 @@
+# Oaken Core
+
+**Oaken Core** is the ingestion & enrichment pipeline, the CLI, and the MCP server — the product
+that lets an AI work with your mail, locally, with nothing leaving your machine unless you
+configure it to.
+
+Installing this bundle gives you the whole non-UI product:
+
+- the **pipeline**: mail is pulled to local disk, filtered by your Sieve rules, parsed, indexed
+  (keyword + vectors) and enriched (summary, triage, actions, header/MIME inspector) by a local
+  model at ingest time, so search and question-answering are cheap in tokens;
+- the local **API daemon** on `127.0.0.1` and the read-only `/stats` status page;
+- the **MCP server** (`/mcp`) — the AI-facing surface, so a stronger model can analyse and act on
+  your mail through a narrow, audited, confirm-gated door while the mail stays on your machine;
+- the **`oaken` command line** to start, configure and drive it (`oaken start`, `oaken auth`,
+  `oaken sync`, `oaken search`, `oaken ask`, `oaken pipeline`, `oaken mcp`, …);
+- the first-party plugins: Gmail, IMAP, SMTP, Ollama, the enrichers, and the sqlite-vec store.
+
+```bash
+pip install oaken-core
+```
+
+The web UI is a **separate product**, built on the same API and CLI framework — install it on its
+own with `pip install oaken-webui`. Other front-ends (desktop, mobile) are anticipated and are
+likewise separate products that build on Oaken Core's HTTP API and MCP surfaces. See
+[ADR 0014](../../docs/adr/0014-product-family-and-ui-surfaces.md) for the product family and the
+surfaces a UI builds on.
+
+License: Apache-2.0.

oaken_core-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "oaken-core"
+dynamic = ["version"]  # one source of truth: src/oaken/__init__.py (the whole product shares it)
+description = "Oaken Core — the ingestion & enrichment pipeline, the CLI, and the MCP server, so an AI can work with your mail."
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.11"
+keywords = ["oaken", "email", "mail", "mua", "local-first", "ai", "mcp", "llm", "rag"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "Programming Language :: Python :: 3",
+    "Topic :: Communications :: Email",
+    "Topic :: Communications :: Email :: Email Clients (MUA)",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+# A bundle, not code: it pulls together the product (ADR 0014). `oaken` is the engine (pipeline,
+# API daemon, MCP server, first-party plugins); `oaken-cli` is the management surface and the stdio
+# MCP bridge; `oaken[vec]` adds the sqlite-vec native library for embeddings. The web UI is a
+# separate product (`oaken-webui`) and is deliberately NOT included.
+# The pins below are the one spot that restates the version (a dependency string can't be dynamic);
+# tests/test_version_lockstep.py asserts they match the shared version so they cannot drift.
+dependencies = [
+    "oaken[vec]==0.1.0",
+    "oaken-cli==0.1.0",
+]
+
+[project.urls]
+Homepage = "https://dfoulks1.github.io/oaken-mail/"
+Source = "https://github.com/dfoulks1/oaken-mail"
+
+[tool.uv.sources]
+oaken = { workspace = true }
+oaken-cli = { workspace = true }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "regex"
+path = "../../src/oaken/__init__.py"
+pattern = '__version__ = "(?P<version>[^"]+)"'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oaken_core"]

oaken_core-0.1.0/src/oaken_core/__init__.py

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: Apache-2.0
+"""Oaken Core — the product bundle.
+
+Installing ``oaken-core`` brings in the whole non-UI product (ADR 0014): the ingestion and
+enrichment pipeline and the local API daemon (``oaken``, with the first-party Gmail, IMAP, SMTP,
+Ollama, enricher and vector-store plugins), the MCP server that lets an AI work with your mail
+(hosted in core, at ``/mcp``), and the ``oaken`` command-line interface (``oaken-cli``) that starts,
+configures and drives it. The web UI is a separate product (``oaken-webui``).
+
+This package ships no code of its own; it exists so ``pip install oaken-core`` installs the bundle.
+Its version is the product's single source of truth, ``oaken.__version__`` (all four distributions
+read it), so there is no version literal here to drift.
+"""