oxivault 0.1.0__tar.gz

oxivault-0.1.0/LICENSE

@@ -0,0 +1,211 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor
+hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable copyright license to reproduce, prepare
+Derivative Works of, publicly display, publicly perform, sublicense,
+and distribute the Work and such Derivative Works in Source or Object
+form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor
+hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and
+otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily
+infringed by their Contribution(s) alone or by combination of their
+Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+the Work or a Contribution incorporated within the Work constitutes
+direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works
+thereof in any medium, with or without modifications, and in Source or
+Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally
+submitted for inclusion in the Work by You to the Licensor shall be
+under the terms and conditions of this License, without any additional
+terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of
+the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor
+provides the Work (and each Contributor provides its Contributions) on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied, including, without limitation, any warranties or
+conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
+A PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including
+negligence), contract, or otherwise, unless required by applicable law
+(such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of
+any character arising as a result of this License or out of the use or
+inability to use the Work (including but not limited to damages for
+loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such
+Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may
+choose to offer, and charge a fee for, acceptance of support, warranty,
+indemnity, or other liability obligations and/or rights consistent with
+this License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf of
+any other Contributor, and only if You agree to indemnify, defend, and
+hold each Contributor harmless for any liability incurred by, or claims
+asserted against, such Contributor by reason of your accepting any such
+warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!) The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2026 Daniel Kapitan
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

oxivault-0.1.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: oxivault
+Version: 0.1.0
+Summary: Vault-LD knowledge graph store on object storage
+Keywords: vault-ld,knowledge-graph,rdf,sparql,obsidian,markdown,s3,fastapi
+Author: Daniel Kapitan
+Author-email: Daniel Kapitan <daniel@kapitan.net>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Dist: boto3>=1.35.0
+Requires-Dist: click>=8.5.0
+Requires-Dist: dulwich>=0.22.0
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: polars>=1.44.2
+Requires-Dist: pydantic>=2.10.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rdflib>=7.1.0
+Requires-Dist: uvicorn>=0.34.0
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/dkapitan/oxivault
+Project-URL: Repository, https://github.com/dkapitan/oxivault
+Project-URL: Issues, https://github.com/dkapitan/oxivault/issues
+Project-URL: Changelog, https://github.com/dkapitan/oxivault/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# OxiVault
+
+[![PyPI](https://img.shields.io/pypi/v/oxivault)](https://pypi.org/project/oxivault/)
+[![Python](https://img.shields.io/pypi/pyversions/oxivault)](https://pypi.org/project/oxivault/)
+
+Vault-LD knowledge graph store on object storage.
+
+`oxivault` converts Obsidian-style Markdown vaults to and from RDF using in-process Vault-LD reference algorithms and RDFLib. It supports local files, in-memory stores, Git repositories, and S3-compatible object storage, with CLI, Python, and HTTP API interfaces.
+
+## Upstream specification and reference credit
+
+OxiVault builds on the original Vault-LD work from The Knowledge Graph Guys:
+
+- Specification: [Vault-LD SPEC.md](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/SPEC.md)
+- Reference implementation:
+  - [scripts/vault_to_rdf.py](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/scripts/vault_to_rdf.py)
+  - [scripts/rdf_to_vault.py](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/scripts/rdf_to_vault.py)
+
+This project adapts those reference conversion algorithms for in-process library use under `src/oxivault/_reference/vault_ld/`.
+
+## Features
+
+- **Vault ↔ RDF conversion**
+  - `vault2rdf`: export vault content to `schema.ttl` and `data.ttl`
+  - `rdf2vault`: ingest RDF into Markdown notes with frontmatter
+- **Graph access and querying**
+  - Canonical triples table via `Vault.triples()` (Polars DataFrame)
+  - SPARQL querying via `Vault.query()` and `oxivault query`
+  - Graph exploration via `neighbors()`, `backlinks()`, `search()`, `search_body()`
+- **Note CRUD with optimistic concurrency**
+  - `get_note()`, `put_note()`, `delete_note()`, `list_notes()`, `exists_note()`
+- **ObjectStore backends**
+  - `LocalDirStore`, `MemoryStore`, `S3Store`, `GitStore`
+- **Sync engine**
+  - Two-way sync between local vaults and S3-compatible storage (`oxivault sync`)
+- **HTTP API server (FastAPI)**
+  - Endpoints for notes, graph querying, search, and reindexing
+
+## Requirements
+
+- Python **3.14+**
+- For S3 sync/backends: credentials configured for your AWS or S3-compatible provider (through boto3/client configuration)
+
+## Installation
+
+```bash
+pip install oxivault
+```
+
+With `uv`:
+
+```bash
+uv add oxivault
+```
+
+## CLI quick start
+
+Export a vault to RDF:
+
+```bash
+oxivault vault2rdf ./my-vault --out-dir ./dist --source
+```
+
+Ingest RDF into a vault:
+
+```bash
+oxivault rdf2vault ./my-vault ./graph.ttl
+```
+
+Run a SPARQL query:
+
+```bash
+oxivault query ./my-vault "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
+```
+
+Sync local vault with S3:
+
+```bash
+oxivault sync ./my-vault --bucket my-s3-vault --direction both
+```
+
+Start the HTTP API server:
+
+```bash
+oxivault serve ./my-vault --host 127.0.0.1 --port 8000
+```
+
+## Python quick start
+
+```python
+from oxivault.models import RdfDocument
+from oxivault.store.memory import MemoryStore
+from oxivault.vault import Vault
+
+store = MemoryStore()
+vault = Vault(store)
+
+rdf = b"""@prefix ex: <https://example.org/> .
+@prefix data: <https://example.org/data/> .
+
+data:item1 a ex:Thing .
+"""
+
+vault.rdf2vault([RdfDocument(content=rdf, format="turtle")])
+
+triples = vault.triples()
+print(triples.select(["subject", "predicate", "object"]))
+```
+
+## HTTP API
+
+Run:
+
+```bash
+oxivault serve ./my-vault --port 8000
+```
+
+Then use:
+
+- `GET /vault`
+- `GET /notes`
+- `GET /notes/{path}`
+- `PUT /notes/{path}`
+- `DELETE /notes/{path}`
+- `POST /graph/sparql`
+- `GET /graph/edges?subject=...`
+- `GET /graph/issues`
+- `GET /search?q=...`
+- `POST /reindex`
+
+Interactive docs are available at `/docs`.
+
+## Conversion behavior and constraints
+
+- Not all RDF graphs are representable as vault notes. Check reported conversion issues when ingesting/exporting.
+- CLI RDF ingest accepts `.ttl` (Turtle) and `.nt` (N-Triples) files.
+- `Vault.vault2rdf()` and `oxivault vault2rdf` default to query-oriented export. Use `source=True` (Python) or `--source` (CLI) to include placement metadata for roundtrip location fidelity.
+- `Vault.rdf2vault([])` is invalid (empty sequence). Passing a non-empty sequence with an empty RDF document is valid.
+
+## Examples
+
+Runnable examples are in `examples/`:
+
+- `examples/local_store_demo.py`
+- `examples/roundtrip_demo.py`
+- `examples/graph_query_demo.py`
+- `examples/server_and_backends_demo.py`
+
+Run an example:
+
+```bash
+uv run python examples/roundtrip_demo.py
+```
+
+## Development
+
+```bash
+uv sync --group dev
+tara check
+```
+
+## Release and PyPI publishing
+
+Publishing is automated with GitHub tags through `.github/workflows/publish.yml`.
+Create and push an annotated SemVer tag to publish, for example:
+
+```bash
+git tag -a v0.1.0 -m "Release 0.1.0"
+git push origin v0.1.0
+```
+
+The publish workflow builds source and wheel distributions and uploads them to PyPI with GitHub OIDC trusted publishing.
+Configure a PyPI trusted publisher for `dkapitan/oxivault` that points to workflow `publish.yml` and environment `pypi`.
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](LICENSE).
+
+## Project links
+
+- Source: https://github.com/dkapitan/oxivault
+- Issue tracker: https://github.com/dkapitan/oxivault/issues
+- Changelog: [CHANGELOG.md](CHANGELOG.md)

oxivault-0.1.0/README.md

@@ -0,0 +1,183 @@
+# OxiVault
+
+[![PyPI](https://img.shields.io/pypi/v/oxivault)](https://pypi.org/project/oxivault/)
+[![Python](https://img.shields.io/pypi/pyversions/oxivault)](https://pypi.org/project/oxivault/)
+
+Vault-LD knowledge graph store on object storage.
+
+`oxivault` converts Obsidian-style Markdown vaults to and from RDF using in-process Vault-LD reference algorithms and RDFLib. It supports local files, in-memory stores, Git repositories, and S3-compatible object storage, with CLI, Python, and HTTP API interfaces.
+
+## Upstream specification and reference credit
+
+OxiVault builds on the original Vault-LD work from The Knowledge Graph Guys:
+
+- Specification: [Vault-LD SPEC.md](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/SPEC.md)
+- Reference implementation:
+  - [scripts/vault_to_rdf.py](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/scripts/vault_to_rdf.py)
+  - [scripts/rdf_to_vault.py](https://github.com/The-Knowledge-Graph-Guys/vault-ld/blob/025e71be8d810e387dc451c920e05472d1c47170/scripts/rdf_to_vault.py)
+
+This project adapts those reference conversion algorithms for in-process library use under `src/oxivault/_reference/vault_ld/`.
+
+## Features
+
+- **Vault ↔ RDF conversion**
+  - `vault2rdf`: export vault content to `schema.ttl` and `data.ttl`
+  - `rdf2vault`: ingest RDF into Markdown notes with frontmatter
+- **Graph access and querying**
+  - Canonical triples table via `Vault.triples()` (Polars DataFrame)
+  - SPARQL querying via `Vault.query()` and `oxivault query`
+  - Graph exploration via `neighbors()`, `backlinks()`, `search()`, `search_body()`
+- **Note CRUD with optimistic concurrency**
+  - `get_note()`, `put_note()`, `delete_note()`, `list_notes()`, `exists_note()`
+- **ObjectStore backends**
+  - `LocalDirStore`, `MemoryStore`, `S3Store`, `GitStore`
+- **Sync engine**
+  - Two-way sync between local vaults and S3-compatible storage (`oxivault sync`)
+- **HTTP API server (FastAPI)**
+  - Endpoints for notes, graph querying, search, and reindexing
+
+## Requirements
+
+- Python **3.14+**
+- For S3 sync/backends: credentials configured for your AWS or S3-compatible provider (through boto3/client configuration)
+
+## Installation
+
+```bash
+pip install oxivault
+```
+
+With `uv`:
+
+```bash
+uv add oxivault
+```
+
+## CLI quick start
+
+Export a vault to RDF:
+
+```bash
+oxivault vault2rdf ./my-vault --out-dir ./dist --source
+```
+
+Ingest RDF into a vault:
+
+```bash
+oxivault rdf2vault ./my-vault ./graph.ttl
+```
+
+Run a SPARQL query:
+
+```bash
+oxivault query ./my-vault "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
+```
+
+Sync local vault with S3:
+
+```bash
+oxivault sync ./my-vault --bucket my-s3-vault --direction both
+```
+
+Start the HTTP API server:
+
+```bash
+oxivault serve ./my-vault --host 127.0.0.1 --port 8000
+```
+
+## Python quick start
+
+```python
+from oxivault.models import RdfDocument
+from oxivault.store.memory import MemoryStore
+from oxivault.vault import Vault
+
+store = MemoryStore()
+vault = Vault(store)
+
+rdf = b"""@prefix ex: <https://example.org/> .
+@prefix data: <https://example.org/data/> .
+
+data:item1 a ex:Thing .
+"""
+
+vault.rdf2vault([RdfDocument(content=rdf, format="turtle")])
+
+triples = vault.triples()
+print(triples.select(["subject", "predicate", "object"]))
+```
+
+## HTTP API
+
+Run:
+
+```bash
+oxivault serve ./my-vault --port 8000
+```
+
+Then use:
+
+- `GET /vault`
+- `GET /notes`
+- `GET /notes/{path}`
+- `PUT /notes/{path}`
+- `DELETE /notes/{path}`
+- `POST /graph/sparql`
+- `GET /graph/edges?subject=...`
+- `GET /graph/issues`
+- `GET /search?q=...`
+- `POST /reindex`
+
+Interactive docs are available at `/docs`.
+
+## Conversion behavior and constraints
+
+- Not all RDF graphs are representable as vault notes. Check reported conversion issues when ingesting/exporting.
+- CLI RDF ingest accepts `.ttl` (Turtle) and `.nt` (N-Triples) files.
+- `Vault.vault2rdf()` and `oxivault vault2rdf` default to query-oriented export. Use `source=True` (Python) or `--source` (CLI) to include placement metadata for roundtrip location fidelity.
+- `Vault.rdf2vault([])` is invalid (empty sequence). Passing a non-empty sequence with an empty RDF document is valid.
+
+## Examples
+
+Runnable examples are in `examples/`:
+
+- `examples/local_store_demo.py`
+- `examples/roundtrip_demo.py`
+- `examples/graph_query_demo.py`
+- `examples/server_and_backends_demo.py`
+
+Run an example:
+
+```bash
+uv run python examples/roundtrip_demo.py
+```
+
+## Development
+
+```bash
+uv sync --group dev
+tara check
+```
+
+## Release and PyPI publishing
+
+Publishing is automated with GitHub tags through `.github/workflows/publish.yml`.
+Create and push an annotated SemVer tag to publish, for example:
+
+```bash
+git tag -a v0.1.0 -m "Release 0.1.0"
+git push origin v0.1.0
+```
+
+The publish workflow builds source and wheel distributions and uploads them to PyPI with GitHub OIDC trusted publishing.
+Configure a PyPI trusted publisher for `dkapitan/oxivault` that points to workflow `publish.yml` and environment `pypi`.
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](LICENSE).
+
+## Project links
+
+- Source: https://github.com/dkapitan/oxivault
+- Issue tracker: https://github.com/dkapitan/oxivault/issues
+- Changelog: [CHANGELOG.md](CHANGELOG.md)