auralith-aura 0.1.0__tar.gz

auralith_aura-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2024-2026 Auralith Inc.
+
+   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.

auralith_aura-0.1.0/PKG-INFO

@@ -0,0 +1,369 @@
+Metadata-Version: 2.4
+Name: auralith-aura
+Version: 0.1.0
+Summary: The Universal Context Compiler for AI Agent Memory
+Home-page: https://github.com/Auralith-Inc/aura-core
+Author: Auralith Inc.
+Author-email: "Auralith Inc." <info@auralith.org>
+License: Apache-2.0
+Project-URL: Homepage, https://aura.auralith.org
+Project-URL: Documentation, https://github.com/Auralith-Inc/aura-core#readme
+Project-URL: Repository, https://github.com/Auralith-Inc/aura-core.git
+Project-URL: Issues, https://github.com/Auralith-Inc/aura-core/issues
+Project-URL: Changelog, https://github.com/Auralith-Inc/aura-core/releases
+Keywords: ai,agent-memory,rag,retrieval-augmented-generation,context-compiler,openclaw,claude-code,codex,gemini-cli,llm,knowledge-base
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: msgpack>=1.0.0
+Requires-Dist: safetensors>=0.3.0
+Requires-Dist: tqdm>=4.60.0
+Provides-Extra: docs
+Requires-Dist: unstructured>=0.10.0; extra == "docs"
+Requires-Dist: pypdf>=3.0.0; extra == "docs"
+Requires-Dist: python-docx>=0.8.11; extra == "docs"
+Provides-Extra: data
+Requires-Dist: pandas>=1.3.0; extra == "data"
+Requires-Dist: openpyxl>=3.0.0; extra == "data"
+Requires-Dist: pyarrow>=10.0.0; extra == "data"
+Provides-Extra: all
+Requires-Dist: auralith-aura[data,docs]; extra == "all"
+Requires-Dist: unstructured[all-docs]>=0.10.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+<p align="center">
+  <img src="logo.png" alt="Auralith Logo" width="120">
+  <h1 align="center">Aura: The Universal Context Compiler</h1>
+  <p align="center">
+    <strong>Compile any document into AI-ready knowledge bases with built-in agent memory.</strong>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/auralith-aura/"><img src="https://badge.fury.io/py/auralith-aura.svg" alt="PyPI version"></a>
+  <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License: Apache 2.0"></a>
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python 3.8+"></a>
+  <a href="https://github.com/Auralith-Inc/aura-core"><img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey" alt="Platform"></a>
+</p>
+
+<p align="center">
+  <a href="#-quick-start">Quick Start</a> •
+  <a href="#-agent-memory">Agent Memory</a> •
+  <a href="#-agent-integrations">Integrations</a> •
+  <a href="#-rag-support">RAG Support</a> •
+  <a href="https://aura.auralith.org">Website</a>
+</p>
+
+---
+
+## Context is the new Compute.
+
+Aura compiles messy, real-world files (PDFs, DOCX, HTML, code, spreadsheets — **60+ formats**) into a single optimized binary (`.aura`) ready for **RAG retrieval** and **AI agent memory**.
+
+One command. No JSONL scripting. No parsing pipelines.
+
+```bash
+pip install auralith-aura
+aura compile ./my_data/ --output knowledge.aura
+```
+
+---
+
+## ⚡ Quick Start
+
+### 1. Install
+
+```bash
+pip install auralith-aura
+
+# For full document support (PDFs, DOCX, etc.)
+pip install 'aura-core[all]'
+```
+
+### 2. Compile
+
+```bash
+# Basic compilation
+aura compile ./company_data/ --output knowledge.aura
+
+# With PII masking (emails, phones, SSNs automatically redacted)
+aura compile ./data/ --output knowledge.aura --pii-mask
+
+# Filter low-quality content
+aura compile ./data/ --output knowledge.aura --min-quality 0.3
+```
+
+### 3. Use
+
+**For RAG (Knowledge Retrieval):**
+```python
+from aura.rag import AuraRAGLoader
+
+loader = AuraRAGLoader("knowledge.aura")
+text = loader.get_text_by_id("doc_001")
+
+# Framework wrappers
+langchain_docs = loader.to_langchain_documents()
+llama_docs = loader.to_llama_index_documents()
+```
+
+**For Agent Memory:**
+```python
+from aura.memory import AuraMemoryOS
+
+memory = AuraMemoryOS()
+
+# Write to memory tiers
+memory.write("fact", "User prefers dark mode", source="agent")
+memory.write("episodic", "Discussed deployment strategy")
+memory.write("pad", "TODO: check auth module")
+
+# Search memory
+results = memory.query("user preferences")
+
+# End session (flushes to durable shards)
+memory.end_session()
+```
+
+---
+
+## 🧠 Agent Memory
+
+Aura includes a **3-Tier Memory OS** with a **Two-Speed Write-Ahead Log**:
+
+| Tier | Purpose | Lifecycle |
+|------|---------|-----------|
+| `/pad` | Working notes, scratch space | Transient |
+| `/episodic` | Session transcripts, conversation history | Auto-archived |
+| `/fact` | Verified facts, user preferences | Persistent |
+
+**Two-Speed WAL:**
+- **Speed 1** (~0.001s): Instant JSONL append — agents are never blocked
+- **Speed 2** (background): Compiles to durable `.aura` shards at session end
+
+```bash
+# CLI memory management
+aura memory list       # View all memory shards
+aura memory usage      # Storage usage by tier
+aura memory prune --before 2026-01-01  # Clean up old memories
+```
+
+---
+
+## 🤖 Agent Integrations
+
+Aura works natively with the major AI agent platforms:
+
+| Platform | Repo | Use Case |
+|----------|------|----------|
+| **OpenClaw** | [`aura-openclaw`](https://github.com/Auralith-Inc/aura-openclaw) | Persistent RAG + memory for always-on agents |
+| **Claude Code** | [`aura-claude-code`](https://github.com/Auralith-Inc/aura-claude-code) | Context-aware coding with `/aura` commands |
+| **OpenAI Codex** | [`aura-codex`](https://github.com/Auralith-Inc/aura-codex) | Knowledge-backed Codex agents |
+| **Gemini CLI** | [`aura-gemini-cli`](https://github.com/Auralith-Inc/aura-gemini-cli) | Gemini CLI extension for RAG |
+
+### How It Works (Agent RAG Flow)
+
+```
+You: "Learn everything in my /docs/ folder"
+  → Agent runs: aura compile ./docs/ --output knowledge.aura
+  → Agent loads: AuraRAGLoader("knowledge.aura")
+  → You: "What does the auth module do?"
+  → Agent queries the .aura file and responds with cited answers
+```
+
+---
+
+## 🌟 Key Features
+
+| Feature | Description |
+|---------|-------------|
+| **Universal Ingestion** | Parses 60+ formats: PDF, DOCX, HTML, MD, CSV, code, and more |
+| **Agent Memory OS** | 3-tier memory (pad/episodic/fact) with instant writes |
+| **PII Masking** | Automatically redacts emails, phones, SSNs before compilation |
+| **Instant RAG** | Query any document by keyword or ID. LangChain + LlamaIndex wrappers |
+| **Quality Filtering** | Skip low-quality content with configurable thresholds |
+| **Cross-Platform** | macOS, Windows, and Linux |
+| **Secure by Design** | No pickle. No arbitrary code execution. Safe to share. |
+
+---
+
+## 📁 Supported File Formats
+
+<details>
+<summary><b>Documents</b> - PDF, DOCX, HTML, and more</summary>
+
+- `.pdf`, `.docx`, `.doc`, `.rtf`, `.odt`, `.epub`, `.txt`, `.pages`, `.wpd`
+- `.html`, `.htm`, `.xml`
+- `.eml`, `.msg` (emails)
+- `.pptx`, `.ppt` (presentations)
+
+</details>
+
+<details>
+<summary><b>Data</b> - Spreadsheets and structured data</summary>
+
+- `.csv`, `.tsv`
+- `.xlsx`, `.xls`
+- `.parquet`
+- `.json`, `.jsonl`
+- `.yaml`, `.yml`, `.toml`
+
+</details>
+
+<details>
+<summary><b>Code</b> - All major programming languages</summary>
+
+- **Python**: `.py`, `.pyi`, `.ipynb`
+- **Web**: `.js`, `.ts`, `.jsx`, `.tsx`, `.css`
+- **Systems**: `.c`, `.cpp`, `.h`, `.hpp`, `.rs`, `.go`, `.java`, `.kt`, `.swift`
+- **Scripts**: `.sh`, `.bash`, `.zsh`, `.ps1`, `.bat`
+- **Backend**: `.sql`, `.php`, `.rb`, `.cs`, `.scala`
+- **Config**: `.ini`, `.cfg`, `.conf`, `.env`, `.dockerfile`
+
+</details>
+
+<details>
+<summary><b>Markup</b> - Documentation formats</summary>
+
+- `.md` (Markdown)
+- `.rst` (reStructuredText)
+- `.tex`, `.latex`
+
+</details>
+
+---
+
+## 🔧 CLI Reference
+
+```bash
+aura compile <input_directory> --output <file.aura> [options]
+
+Options:
+  --pii-mask           Mask PII (emails, phones, SSNs)
+  --min-quality SCORE  Filter low-quality content (0.0-1.0)
+  --domain DOMAIN      Tag with domain context
+  --no-recursive       Don't search subdirectories
+  --verbose, -v        Verbose output
+```
+
+### Memory Management
+
+```bash
+aura memory list                        # List all memory shards
+aura memory usage                       # Show storage by tier
+aura memory prune --before 2026-01-01   # Remove old shards
+aura memory prune --id <shard_id>       # Remove specific shard
+```
+
+### Inspect an Archive
+
+```bash
+aura info knowledge.aura
+
+📦 Aura Archive: knowledge.aura
+   Datapoints: 1,234
+   
+   Sample datapoint:
+     Tensors: ['raw_text']
+     Source:  legal/contract_001.pdf
+```
+
+---
+
+## 🔌 RAG Support
+
+```python
+from aura.rag import AuraRAGLoader
+
+loader = AuraRAGLoader("knowledge.aura")
+
+# Text retrieval
+text = loader.get_text_by_id("doc_001")
+
+# Filter documents
+pdf_docs = loader.filter_by_extension(".pdf")
+legal_docs = loader.filter_by_source("legal/")
+
+# Framework wrappers
+langchain_docs = loader.to_langchain_documents()  # LangChain
+llama_docs = loader.to_llama_index_documents()     # LlamaIndex
+dict_list = loader.to_dict_list()                  # Universal
+
+# Statistics
+stats = loader.get_stats()
+```
+
+---
+
+## 📐 File Format Specification
+
+The `.aura` format is a secure, indexed binary archive:
+
+```
+[Datapoint 1][Datapoint 2]...[Datapoint N][Index][Footer]
+
+Each Datapoint:
+  [meta_length: 4 bytes, uint32]
+  [tensor_length: 4 bytes, uint32]
+  [metadata: msgpack bytes]
+  [tensors: safetensors bytes]
+
+Footer:
+  [index_offset: 8 bytes, uint64]
+  [magic: 4 bytes, 'AURA']
+```
+
+**Security**: Uses `safetensors` (not pickle) — safe to load untrusted files.
+
+---
+
+## 💻 System Requirements
+
+| Use Case | Files | RAM | Time |
+|----------|-------|-----|------|
+| Personal docs | 50–500 | ~2 GB | < 1 min |
+| Team knowledge base | 500–5,000 | ~4 GB | 5–15 min |
+| Enterprise corpus | 5,000–50,000 | ~8 GB | 30–60 min |
+
+**Platforms**: macOS, Windows, Linux  
+**Python**: 3.8+
+
+---
+
+## 📜 License
+
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+---
+
+## 🔗 Links
+
+- **Website**: [aura.auralith.org](https://aura.auralith.org)
+- **PyPI**: [pypi.org/project/auralith-aura](https://pypi.org/project/auralith-aura)
+- **GitHub**: [github.com/Auralith-Inc/aura-core](https://github.com/Auralith-Inc/aura-core)
+- **OpenClaw Skill**: [github.com/Auralith-Inc/aura-openclaw](https://github.com/Auralith-Inc/aura-openclaw)
+
+---
+
+<p align="center">
+Made with ❤️ by <a href="https://auralith.org">Auralith Inc.</a>
+</p>