memorisdk 1.0.0__tar.gz

memorisdk-1.0.0/LICENSE

@@ -0,0 +1,203 @@
+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 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
+(which shall not include communications that are reasonably
+considered separate from, or merely to link to (or bind by name)
+the interfaces of, the Work and separate works which communicate
+with the Work solely through the Work's public interfaces).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based upon (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 separate works which communicate with the Work solely
+through the Work's public interfaces.
+
+"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 use, reproduce, modify, distribute, and prepare
+Derivative Works of the Work, and to publicly display and perform the
+Work and such Derivative Works in all media and formats whether now
+known or hereafter devised.
+
+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, trademark, patent,
+attribution and other 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 notice 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 Support. You may choose to offer, and to
+charge a fee for, warranty, support, 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 support.
+
+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 [2025] [Memori Team]
+
+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.

memorisdk-1.0.0/PKG-INFO

@@ -0,0 +1,386 @@
+Metadata-Version: 2.4
+Name: memorisdk
+Version: 1.0.0
+Summary: The Open-Source Memory Layer for AI Agents & Multi-Agent Systems
+Author-email: Memori Team <contact@memoriai.dev>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/GibsonAI/memoriai
+Project-URL: Documentation, https://gibsonai.github.io/memoriai
+Project-URL: Repository, https://github.com/GibsonAI/memoriai.git
+Project-URL: Bug Tracker, https://github.com/GibsonAI/memoriai/issues
+Project-URL: Changelog, https://github.com/GibsonAI/memoriai/blob/main/CHANGELOG.md
+Project-URL: Contributing, https://github.com/GibsonAI/memoriai/blob/main/CONTRIBUTING.md
+Keywords: ai,memory,agents,llm,artificial-intelligence,multi-agent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+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: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru>=0.6.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: openai>=1.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: isort>=5.9.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: pre-commit>=2.15; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.0; extra == "docs"
+Requires-Dist: mkdocs-minify-plugin>=0.7.0; extra == "docs"
+Requires-Dist: mkdocs-redirects>=1.2.0; extra == "docs"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "postgres"
+Provides-Extra: mysql
+Requires-Dist: PyMySQL>=1.0.0; extra == "mysql"
+Provides-Extra: integrations
+Requires-Dist: litellm>=1.0.0; extra == "integrations"
+Requires-Dist: anthropic>=0.3.0; extra == "integrations"
+Provides-Extra: all
+Requires-Dist: black>=23.0; extra == "all"
+Requires-Dist: ruff>=0.1.0; extra == "all"
+Requires-Dist: isort>=5.9.0; extra == "all"
+Requires-Dist: mypy>=1.0; extra == "all"
+Requires-Dist: pre-commit>=2.15; extra == "all"
+Requires-Dist: mkdocs>=1.5.0; extra == "all"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "all"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.0; extra == "all"
+Requires-Dist: mkdocs-minify-plugin>=0.7.0; extra == "all"
+Requires-Dist: mkdocs-redirects>=1.2.0; extra == "all"
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "all"
+Requires-Dist: PyMySQL>=1.0.0; extra == "all"
+Requires-Dist: litellm>=1.0.0; extra == "all"
+Requires-Dist: anthropic>=0.3.0; extra == "all"
+Dynamic: license-file
+
+# Memoriai
+
+**The Open-Source Memory Layer for AI Agents & Multi-Agent Systems v1.2**
+
+*Give your AI agents structured, persistent memory with intelligent context injection - no more repeating yourself!*
+
+[![PyPI version](https://badge.fury.io/py/memoriai.svg)](https://badge.fury.io/py/memoriai)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+
+---
+
+## 🎯 Philosophy
+
+- **Second-memory for all your LLM work** - Never repeat context again
+- **Dual-mode memory injection** - Conscious short-term memory + Auto intelligent search
+- **Flexible database connections** - SQLite, PostgreSQL, MySQL support  
+- **Pydantic-based intelligence** - Structured memory processing with validation
+- **Simple, reliable architecture** - Just works out of the box
+
+## ⚡ Quick Start
+
+```bash
+pip install memoriai
+```
+
+```python
+from memoriai import Memori
+
+# Create your workspace memory with conscious mode
+office_work = Memori(
+    database_connect="sqlite:///office_memory.db",
+    conscious_ingest=True,  # Short-term working memory (one-shot context)
+    openai_api_key="your-key"
+)
+
+office_work.enable()  # Start recording conversations
+
+# Use ANY LLM library - context automatically injected!
+from litellm import completion
+
+response = completion(
+    model="gpt-4o", 
+    messages=[{"role": "user", "content": "Help me with Python testing"}]
+)
+# ✨ Short-term working memory automatically included once per session
+```
+
+## 🧠 How It Works
+
+### 1. **Universal Recording**
+```python
+office_work.enable()  # Records ALL LLM conversations automatically
+```
+
+### 2. **Intelligent Processing**
+- **Entity Extraction**: Extracts people, technologies, projects
+- **Smart Categorization**: Facts, preferences, skills, rules
+- **Pydantic Validation**: Structured, type-safe memory storage
+
+### 3. **Dual Memory Modes**
+
+#### **🧠 Conscious Mode** - Short-Term Working Memory
+```python
+conscious_ingest=True  # One-shot short-term memory injection
+```
+- **At Startup**: Conscious agent analyzes long-term memory patterns
+- **Memory Promotion**: Moves essential conversations to short-term storage
+- **One-Shot Injection**: Injects working memory once at conversation start
+- **Like Human Short-Term Memory**: Names, current projects, preferences readily available
+
+#### **🔍 Auto Mode** - Dynamic Database Search
+```python
+auto_ingest=True  # Continuous intelligent memory retrieval
+```
+- **Every LLM Call**: Retrieval agent analyzes user query intelligently
+- **Full Database Search**: Searches through entire memory database
+- **Context-Aware**: Injects relevant memories based on current conversation
+- **Performance Optimized**: Caching, async processing, background threads
+
+## 🧠 Memory Modes Explained
+
+### **Conscious Mode** - Short-Term Working Memory
+```python
+# Mimics human conscious memory - essential info readily available
+memori = Memori(
+    database_connect="sqlite:///my_memory.db",
+    conscious_ingest=True,  # 🧠 Short-term working memory
+    openai_api_key="sk-..."
+)
+```
+
+**How Conscious Mode Works:**
+1. **At Startup**: Conscious agent analyzes long-term memory patterns
+2. **Essential Selection**: Promotes 5-10 most important conversations to short-term
+3. **One-Shot Injection**: Injects this working memory once at conversation start
+4. **No Repeats**: Won't inject again during the same session
+
+### **Auto Mode** - Dynamic Intelligent Search
+```python
+# Searches entire database dynamically based on user queries
+memori = Memori(
+    database_connect="sqlite:///my_memory.db", 
+    auto_ingest=True,  # 🔍 Smart database search
+    openai_api_key="sk-..."
+)
+```
+
+**How Auto Mode Works:**
+1. **Every LLM Call**: Retrieval agent analyzes user input
+2. **Query Planning**: Uses AI to understand what memories are needed
+3. **Smart Search**: Searches through entire database (short-term + long-term)
+4. **Context Injection**: Injects 3-5 most relevant memories per call
+
+### **Combined Mode** - Best of Both Worlds
+```python
+# Get both working memory AND dynamic search
+memori = Memori(
+    conscious_ingest=True,  # Working memory once
+    auto_ingest=True,       # Dynamic search every call
+    openai_api_key="sk-..."
+)
+```
+
+### **Intelligence Layers:**
+
+1. **Memory Agent** - Processes every conversation with Pydantic structured outputs
+2. **Conscious Agent** - Analyzes patterns, promotes long-term → short-term memories
+3. **Retrieval Agent** - Intelligently searches and selects relevant context
+
+### **What gets prioritized in Conscious Mode:**
+- 👤 **Personal Identity**: Your name, role, location, basic info
+- ❤️ **Preferences & Habits**: What you like, work patterns, routines
+- 🛠️ **Skills & Tools**: Technologies you use, expertise areas
+- 📊 **Current Projects**: Ongoing work, learning goals
+- 🤝 **Relationships**: Important people, colleagues, connections
+- 🔄 **Repeated References**: Information you mention frequently
+
+## 🗄️ Memory Types
+
+| Type | Purpose | Example | Auto-Promoted |
+|------|---------|---------|---------------|
+| **Facts** | Objective information | "I use PostgreSQL for databases" | ✅ High frequency |
+| **Preferences** | User choices | "I prefer clean, readable code" | ✅ Personal identity |
+| **Skills** | Abilities & knowledge | "Experienced with FastAPI" | ✅ Expertise areas |
+| **Rules** | Constraints & guidelines | "Always write tests first" | ✅ Work patterns |
+| **Context** | Session information | "Working on e-commerce project" | ✅ Current projects |
+
+## 🔧 Configuration
+
+### Simple Setup
+```python
+from memoriai import Memori
+
+# Conscious mode - Short-term working memory
+memori = Memori(
+    database_connect="sqlite:///my_memory.db",
+    template="basic", 
+    conscious_ingest=True,  # One-shot context injection
+    openai_api_key="sk-..."
+)
+
+# Auto mode - Dynamic database search
+memori = Memori(
+    database_connect="sqlite:///my_memory.db",
+    auto_ingest=True,  # Continuous memory retrieval
+    openai_api_key="sk-..."
+)
+
+# Combined mode - Best of both worlds
+memori = Memori(
+    conscious_ingest=True,  # Working memory + 
+    auto_ingest=True,       # Dynamic search
+    openai_api_key="sk-..."
+)
+```
+
+### Advanced Configuration
+```python
+from memoriai import Memori, ConfigManager
+
+# Load from memori.json or environment
+config = ConfigManager()
+config.auto_load()
+
+memori = Memori()
+memori.enable()
+```
+
+Create `memori.json`:
+```json
+{
+  "database": {
+    "connection_string": "postgresql://user:pass@localhost/memori"
+  },
+  "agents": {
+    "openai_api_key": "sk-...",
+    "conscious_ingest": true,
+    "auto_ingest": false
+  },
+  "memory": {
+    "namespace": "my_project",
+    "retention_policy": "30_days"
+  }
+}
+```
+
+## 🔌 Universal Integration
+
+Works with **ANY** LLM library:
+
+```python
+memori.enable()  # Enable universal recording
+
+# LiteLLM (recommended)
+from litellm import completion
+completion(model="gpt-4", messages=[...])
+
+# OpenAI
+import openai
+client = openai.OpenAI()
+client.chat.completions.create(...)
+
+# Anthropic  
+import anthropic
+client = anthropic.Anthropic()
+client.messages.create(...)
+
+# All automatically recorded and contextualized!
+```
+
+## 🛠️ Memory Management
+
+### **Automatic Background Analysis**
+```python
+# Automatic analysis every 6 hours (when conscious_ingest=True)
+memori.enable()  # Starts background conscious agent
+
+# Manual analysis trigger
+memori.trigger_conscious_analysis()
+
+# Get essential conversations
+essential = memori.get_essential_conversations(limit=5)
+```
+
+### **Memory Retrieval Tools**
+```python
+from memoriai.tools import create_memory_tool
+
+# Create memory search tool for your LLM
+memory_tool = create_memory_tool(memori)
+
+# Use in function calling
+tools = [memory_tool]
+completion(model="gpt-4", messages=[...], tools=tools)
+```
+
+### **Context Control**
+```python
+# Get relevant context for a query
+context = memori.retrieve_context("Python testing", limit=5)
+# Returns: 3 essential + 2 specific memories
+
+# Search by category
+skills = memori.search_memories_by_category("skill", limit=10)
+
+# Get memory statistics
+stats = memori.get_memory_stats()
+```
+
+## 📋 Database Schema
+
+```sql
+-- Core tables created automatically
+chat_history        # All conversations
+short_term_memory   # Recent context (expires)
+long_term_memory    # Permanent insights  
+rules_memory        # User preferences
+memory_entities     # Extracted entities
+memory_relationships # Entity connections
+```
+
+## 📁 Project Structure
+
+```
+memoriai/
+├── core/           # Main Memori class, database manager
+├── agents/         # Memory processing with Pydantic  
+├── database/       # SQLite/PostgreSQL/MySQL support
+├── integrations/   # LiteLLM, OpenAI, Anthropic
+├── config/         # Configuration management
+├── utils/          # Helpers, validation, logging
+└── tools/          # Memory search tools
+```
+
+## 🚀 Examples
+
+- **[Basic Usage](./examples/basic_usage.py)** - Simple memory setup with conscious ingestion
+- **[Personal Assistant](./examples/personal_assistant.py)** - AI assistant with intelligent memory
+- **[Memory Retrieval](./memory_retrival_example.py)** - Function calling with memory tools
+- **[Advanced Config](./examples/advanced_config.py)** - Production configuration
+- **[Interactive Demo](./memori_example.py)** - Live conscious ingestion showcase
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.
+
+## 📄 License
+
+MIT License - see [LICENSE](./LICENSE) for details.
+
+---
+
+*Made for developers who want their AI agents to remember and learn*