hermes-okf 0.1.0__tar.gz

hermes_okf-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check src tests
+
+      - name: Format check with black
+        run: black --check src tests
+
+      - name: Type check with mypy
+        run: mypy src
+
+      - name: Test with pytest
+        run: pytest --cov=hermes_okf --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.12'
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  validate-okf:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: pip install -e ".[dev]"
+      - name: Validate example bundle
+        run: |
+          python -c "
+from hermes_okf.bundle import OKFBundle
+from hermes_okf.validators import OKFValidator
+bundle = OKFBundle('examples/example_bundle')
+validator = OKFValidator(bundle)
+assert validator.is_valid(), 'Example bundle failed validation'
+print('OKF bundle is valid')
+"

hermes_okf-0.1.0/.gitignore

@@ -0,0 +1,148 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+*.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
+.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
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+# VS Code
+.vscode/
+
+# Local knowledge bundles
+*.okf/
+
+# Hermes local state
+.hermes_state/

hermes_okf-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.7
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-PyYAML]

hermes_okf-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-06-15
+
+### Added
+- Initial release of `hermes-okf`
+- `OKFBundle` — core bundle manager with read/write, logging, graph edge extraction
+- `Concept` — dataclass for OKF concepts
+- `GraphExtractor` — link traversal, directory hierarchy, tag clustering, BFS traversal, NetworkX export
+- `SearchIndex` — inverted-index full-text search, fuzzy search, custom predicate filtering
+- `OKFValidator` — OKF v0.1 conformance validation
+- `HermesMemory` — agent memory layer: sessions, decisions, observations, tool calls, context recall
+- `HermesMemoryMixin` — drop-in decorators for agent classes
+- CLI (`hermes-okf`) — init, validate, show, search, log, graph commands
+- RAG integration example (LangChain + ChromaDB)
+- Full test suite with pytest
+- GitHub Actions CI for Python 3.10–3.13

hermes_okf-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing
+
+Thank you for your interest in contributing to Hermes OKF! This is an early-stage
+open-source project and every contribution helps shape the future of agent memory
+systems.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/hermes-okf.git`
+3. Install in development mode: `pip install -e ".[dev]"`
+4. Run tests: `pytest`
+
+## Development Workflow
+
+- **Main branch**: `main` — always deployable
+- **Feature branches**: `feature/your-feature-name`
+- **Bug fixes**: `fix/issue-description`
+
+## Code Quality
+
+We use the following tools (all run in CI):
+
+- **black** — code formatting (`black src tests`)
+- **ruff** — linting (`ruff check src tests`)
+- **mypy** — static type checking (`mypy src`)
+- **pytest** — unit tests (`pytest`)
+
+Pre-commit hooks are encouraged:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+## Writing Tests
+
+- Add tests to the `tests/` directory
+- Name files `test_<module>.py`
+- Use `pytest` fixtures and `tempfile.TemporaryDirectory` for filesystem tests
+- Aim for >80% coverage on new code
+
+## Documentation
+
+- Update `README.md` for user-facing changes
+- Update `docs/ARCHITECTURE.md` for design changes
+- Add examples to `examples/` for new features
+
+## Submitting a PR
+
+1. Ensure all tests pass: `pytest`
+2. Ensure linting passes: `ruff check src tests && black --check src tests`
+3. Write a clear PR description explaining the *why* and *what*
+4. Link any related issues
+
+## Community
+
+- Open an issue for bugs, feature requests, or questions
+- Start a discussion for architectural proposals
+- Be respectful and constructive
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

hermes_okf-0.1.0/LICENSE

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

hermes_okf-0.1.0/PKG-INFO

@@ -0,0 +1,335 @@
+Metadata-Version: 2.4
+Name: hermes-okf
+Version: 0.1.0
+Summary: Universal OKF-based memory system for Hermes agent — structured, persistent, agent-readable knowledge storage.
+Project-URL: Homepage, https://github.com/EliaszDev/hermes-okf
+Project-URL: Documentation, https://github.com/EliaszDev/hermes-okf#readme
+Project-URL: Repository, https://github.com/EliaszDev/hermes-okf
+Project-URL: Issues, https://github.com/EliaszDev/hermes-okf/issues
+Project-URL: Changelog, https://github.com/EliaszDev/hermes-okf/blob/main/CHANGELOG.md
+Author-email: EliaszDev <eliasz@example.com>
+License: MIT License
+        
+        Copyright (c) 2026 EliaszDev
+        
+        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.
+License-File: LICENSE
+Keywords: agent-memory,ai-agent,hermes,knowledge-graph,knowledge-management,markdown,memory-system,okf,open-knowledge-format
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.9
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: all
+Requires-Dist: black>=24.0; extra == 'all'
+Requires-Dist: langchain-chroma>=0.1.0; extra == 'all'
+Requires-Dist: langchain-community>=0.2.0; extra == 'all'
+Requires-Dist: langchain-openai>=0.1.0; extra == 'all'
+Requires-Dist: langchain>=0.2.0; extra == 'all'
+Requires-Dist: mypy>=1.9; extra == 'all'
+Requires-Dist: pre-commit>=3.7; extra == 'all'
+Requires-Dist: pytest-cov>=4.0; extra == 'all'
+Requires-Dist: pytest>=8.0; extra == 'all'
+Requires-Dist: ruff>=0.4.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: mypy>=1.9; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Provides-Extra: rag
+Requires-Dist: langchain-chroma>=0.1.0; extra == 'rag'
+Requires-Dist: langchain-community>=0.2.0; extra == 'rag'
+Requires-Dist: langchain-openai>=0.1.0; extra == 'rag'
+Requires-Dist: langchain>=0.2.0; extra == 'rag'
+Description-Content-Type: text/markdown
+
+# Hermes OKF — Universal Memory for AI Agents
+
+[![CI](https://github.com/EliaszDev/hermes-okf/actions/workflows/ci.yml/badge.svg)](https://github.com/EliaszDev/hermes-okf/actions)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![OKF](https://img.shields.io/badge/OKF-v0.1-green.svg)](https://cloud.google.com/knowledge-catalog)
+
+> **The first open-source memory system built on Google's Open Knowledge Format (OKF) for the Hermes agent ecosystem.**
+
+Hermes OKF gives your AI agent a **persistent, structured, version-controlled memory** — no database, no lock-in, just markdown + YAML on your filesystem. Every decision, observation, and project context lives in a human-readable knowledge graph that your agent can read, write, and traverse programmatically.
+
+---
+
+## Why Hermes OKF?
+
+| Feature | What You Get |
+|---------|-------------|
+| 🧠 **Agent Memory** | Persistent decisions, observations, and tool-call history across sessions |
+| 🔗 **Knowledge Graph** | Implicit graph from markdown links — no RDF, no Cypher |
+| 📁 **Filesystem-First** | Plain `.md` + YAML. `cat` it, `grep` it, Git it. |
+| ⚡ **Zero-DB Core** | Single dependency: `pyyaml`. Optional RAG via LangChain/ChromaDB. |
+| 🎁 **Hermes-Ready** | Drop-in decorators: `@memorize_decision`, `@memorize_tool` |
+| 📦 **Portable** | Clone a bundle to another machine — the agent resumes instantly. |
+
+---
+
+## Quick Start
+
+```bash
+pip install hermes-okf
+```
+
+```python
+from hermes_okf.bundle import OKFBundle
+
+# Create a knowledge bundle
+bundle = OKFBundle("./my_knowledge")
+
+# Store a project concept
+bundle.write_concept(
+    "projects/my_project",
+    body="# My Project\n\nDescribe your project here.",
+    type="Project",
+    title="My Project",
+    tags=["ml", "data", "gpu"],
+    resource="https://github.com/YOUR_USERNAME/my-project",
+)
+
+# Log a decision
+bundle.append_log("Switched from TensorFlow to PyTorch for better ecosystem support", category="Decision")
+
+# Search by tag
+for concept in bundle.search_by_tag("gpu"):
+    print(concept.title)
+
+# Inspect the graph
+for edge in bundle.get_graph_edges():
+    print(f"{edge['source']} -> {edge['target']}")
+```
+
+---
+
+## Agent Integration (Memory Mixin)
+
+```python
+from hermes_okf.agent import HermesMemoryMixin
+
+class MyAgent(HermesMemoryMixin):
+    def __init__(self):
+        super().__init__("./agent_knowledge", agent_id="my-agent-v1")
+        self.start_session()
+
+    @HermesMemoryMixin.memorize_decision
+    def choose_model(self, task: str) -> str:
+        if "code" in task.lower():
+            return "anthropic/claude-3.5-sonnet"
+        return "openai/gpt-4o"
+
+    @HermesMemoryMixin.memorize_tool
+    def scrape_data(self, url: str) -> dict:
+        return {"url": url, "items": 42}
+
+# Run it
+agent = MyAgent()
+agent.choose_model("Write a Python script")
+agent.scrape_data("https://example.com")
+
+# Recall relevant context
+context = agent.with_context("python script", top_k=3)
+```
+
+---
+
+## CLI
+
+```bash
+# Initialise a new OKF bundle
+hermes-okf init ./knowledge
+
+# Validate conformance
+hermes-okf validate --path ./knowledge
+
+# List concepts
+hermes-okf list --path ./knowledge
+
+# Show a concept
+hermes-okf show --path ./knowledge projects/my_project
+
+# Search
+hermes-okf search --path ./knowledge "ffmpeg GPU"
+
+# View log
+hermes-okf log --path ./knowledge
+
+# Append to log
+hermes-okf log-append --path ./knowledge "New decision made" --category Decision
+
+# Graph inspection
+hermes-okf graph-edges --path ./knowledge
+hermes-okf graph-neighbors --path ./knowledge projects/my_project
+```
+
+---
+
+## RAG Integration (Optional)
+
+```bash
+pip install hermes-okf[rag]
+```
+
+Feed your OKF bundle into LangChain + ChromaDB for vector retrieval:
+
+```python
+from langchain_community.document_loaders import DirectoryLoader, TextLoader
+from langchain.text_splitter import MarkdownHeaderTextSplitter
+from langchain_chroma import Chroma
+from langchain_openai import OpenAIEmbeddings
+
+from hermes_okf.bundle import OKFBundle
+
+bundle = OKFBundle("./my_knowledge")
+loader = DirectoryLoader(
+    str(bundle.root),
+    glob="**/*.md",
+    loader_cls=TextLoader,
+    loader_kwargs={"encoding": "utf-8"},
+)
+docs = loader.load()
+
+splitter = MarkdownHeaderTextSplitter(
+    headers_to_split_on=[("#", "Header 1"), ("##", "Header 2")]
+)
+splits = [chunk for doc in docs for chunk in splitter.split_text(doc.page_content)]
+
+vectorstore = Chroma.from_documents(
+    documents=splits,
+    embedding=OpenAIEmbeddings(),
+    persist_directory="./chroma_okf_db",
+)
+
+# Query
+retriever = vectorstore.as_retriever(search_kwargs={"k": 5})
+results = retriever.invoke("What GPU decisions did we make?")
+```
+
+See `examples/rag_integration.py` for a complete example.
+
+---
+
+## Architecture
+
+```
+┌─────────────────────────────────────┐
+│  CLI (hermes-okf)                   │
+├─────────────────────────────────────┤
+│  HermesMemory / MemoryMixin         │  ← Agent integration
+├─────────────────────────────────────┤
+│  OKFBundle                          │  ← Core read/write API
+│  ├── Concept (dataclass)            │
+│  ├── GraphExtractor                 │
+│  ├── SearchIndex                    │
+│  └── OKFValidator                   │
+├─────────────────────────────────────┤
+│  Filesystem (markdown + YAML)       │  ← Persistent storage
+└─────────────────────────────────────┘
+```
+
+Read the full architecture in [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md).
+
+---
+
+## OKF Format
+
+This library implements the **Google Open Knowledge Format (OKF) v0.1** spec:
+
+- Every concept is a `.md` file with YAML frontmatter
+- Frontmatter **must** include a `type` field
+- Reserved files: `index.md` (directory), `log.md` (chronology)
+- Markdown links create implicit directed edges
+- Directory structure provides containment hierarchy
+- Tags create cross-cutting clusters
+
+> *"If you can `cat` a file, you can read OKF."*
+
+---
+
+## Project Structure
+
+```
+hermes-okf/
+├── src/hermes_okf/          # Core library
+│   ├── bundle.py             # OKFBundle read/write
+│   ├── concept.py            # Concept dataclass
+│   ├── graph.py              # Graph extraction & traversal
+│   ├── search.py             # Full-text search & indexing
+│   ├── validators.py         # OKF conformance checking
+│   ├── memory.py             # Agent memory layer
+│   ├── agent.py              # Drop-in decorators
+│   └── cli.py                # CLI entry point
+├── tests/                    # pytest suite
+├── examples/                 # Usage examples
+├── docs/                     # Architecture docs
+└── .github/workflows/        # CI/CD
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/EliaszDev/hermes-okf.git
+cd hermes-okf
+pip install -e ".[dev]"
+pytest
+```
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for full guidelines.
+
+---
+
+## Roadmap
+
+- [ ] Async I/O support for high-throughput agents
+- [ ] Multi-agent bundle merging and conflict resolution
+- [ ] Git-backed history with automatic diff summaries
+- [ ] Web viewer for knowledge graph exploration
+- [ ] Plugin system for custom concept types and validators
+- [ ] Integration with Hermes agent orchestration layer
+
+---
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).
+
+---
+
+## Acknowledgements
+
+Built for the **Hermes agent ecosystem** and inspired by the Google Cloud Knowledge Catalog team's OKF draft specification. If you use Hermes or OKF, this library is designed to be your memory backbone.
+
+**⭐ Star this repo if you're building agent memory systems — let's make Hermes the best agent framework out there.**