Metadata-Version: 2.4
Name: amrita_core
Version: 0.2.0
Summary: Agent core of Project Amrita
Project-URL: Homepage, https://github.com/AmritaBot/AmritaCore
Project-URL: Source, https://github.com/AmritaBot/AmritaCore
Project-URL: Issue Tracker, https://github.com/AmritaBot/AmritaCore/issues
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastmcp>=2.14.4
Requires-Dist: jieba>=0.42.1
Requires-Dist: loguru>=0.7.3
Requires-Dist: openai>=2.16.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pytz>=2025.2
Dynamic: license-file

# AmritaCore

AmritaCore is the intelligent agent core module of Proj.Amrita, serving as the primary logical or control component of the project. It provides a flexible and extensible framework for implementing AI agents with advanced capabilities.

## 🚀 What is AmritaCore?

AmritaCore is a next-generation agent framework designed to simplify the creation and deployment of intelligent agents. Built with modern Python technologies, it provides a comprehensive solution for implementing AI-powered applications with features like event-driven architecture, tool integration, and multi-modal support.

## 🎯 Mission and Value Proposition

The mission of AmritaCore is to democratize the development of intelligent agents by providing a powerful yet accessible framework. Our core value propositions include:

- **Stream-based Design**: All message outputs are designed as asynchronous streams for real-time responses
- **Security**: Built-in cookie security detection to ensure session safety
- **Vendor Agnostic**: Data types and conversation management are independent of specific providers, offering high portability
- **Extensibility**: Integrated MCP client in extension mechanisms for enhanced system scalability

## 🔑 Key Features

1. **Every is a Stream**: All message outputs are asynchronous stream-based designs supporting real-time responses
2. **Cookie Security Detection**: Built-in cookie security detection functionality to protect session security
3. **Provider Independent Mechanism**: Data types and conversation management are independent of specific vendors, with high portability
4. **MCP Client Support**: Extension mechanisms integrate MCP clients, enhancing system expansion capabilities
5. **Event-Driven Architecture**: Comprehensive event system for flexible and reactive agent behavior
6. **Tool Integration Framework**: Robust system for integrating external tools and services
7. **Advanced Memory Management**: Sophisticated context handling with automatic summarization and token optimization

## 📖 Documentation Structure

This repository contains documentation organized as follows:

- **Level 1: Project Introduction** - Overview of AmritaCore, its purpose, and key characteristics
- **Level 2: Quick Start** - Getting started guides, installation, and minimal examples
- **Level 3: Core Concepts** - Configuration systems, data types, event systems, and tool systems
- **Level 4: Implementation Guide** - Detailed functional implementations and usage patterns
- **Level 5: Extensions & Integration** - How to extend and integrate with other systems
- **Level 6: Security Mechanisms** - Security features and best practices
- **Level 7: Application Scenarios** - Use cases and practical examples
- **Level 8: Best Practices & FAQs** - Troubleshooting and optimization tips
- **Level 9: API Reference** - Complete API documentation
- **Level 10: Appendices** - Glossary, resources, and changelogs

Documentation is currently under construction. For quick start, please refer to the examples in the `demo/` folder.

Please view [Docs](https://amrita-core.suggar.top) for more information.

## 🛠️ Quick Start

To quickly start using AmritaCore, check out the examples in the [demo](./demo/) directory. The basic example demonstrates how to initialize the core, configure settings, and run a simple chat session with the AI assistant.

## 🤝 Contributing

We welcome contributions! Please see our contribution guidelines for more information.

## 📄 License

This project is licensed under the AGPL-3.0 License - see the [LICENSE](./LICENSE) file for details.
