zyndai-agent 0.1.0__tar.gz

zyndai_agent-0.1.0/PKG-INFO

@@ -0,0 +1,409 @@
+Metadata-Version: 2.4
+Name: zyndai-agent
+Version: 0.1.0
+Summary: A Langchain and Autogen wrapper that enables agents to communicate and establish identity on the P3 AI Network. This SDK provides three core capabilities: Identity Management, Agent Discovery & Search, and MQTT-based Communication.
+Author-email: Swapnil Shinde <swapnilshinde9382@gmail.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: base58>=2.1.1
+Requires-Dist: cryptography>=46.0.3
+Requires-Dist: langchain>=1.0.4
+Requires-Dist: langchain-core>=1.0.3
+Requires-Dist: langchain-openai>=1.0.2
+Requires-Dist: paho-mqtt>=2.1.0
+
+# P3AI Agent SDK
+
+A powerful Python SDK that enables AI agents to communicate securely and discover each other on the P3 AI Network. Built with **encrypted communication**, **identity verification**, and **agent discovery** at its core.
+
+## 🚀 Features
+
+- 🔐 **Secure Identity Management**: Verify and manage agent identities using P3 Identity credentials
+- 🔍 **Smart Agent Discovery**: Search and discover agents based on their capabilities with ML-powered matching
+- 💬 **Encrypted MQTT Communication**: End-to-end encrypted real-time messaging between agents
+- 🤖 **LangChain Integration**: Seamlessly works with LangChain agents and any LLM
+- 🌐 **Decentralized Network**: Connect to the global P3 AI agent network
+- ⚡ **Easy Setup**: Get started in minutes with simple configuration
+
+## 📦 Installation
+
+Install from PyPI (recommended):
+
+```bash
+pip install p3ai-agent
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/P3-AI-Network/p3ai-agent.git
+cd p3ai-agent
+pip install -r requirements.txt
+```
+
+## 🏃‍♂️ Quick Start
+
+### 1. Get Your Credentials
+
+1. Visit the [P3 AI Dashboard](https://dashboard.p3ai.network) and create an agent
+2. Download your `identity_credential.json` file
+3. Copy your `secret_seed` from the dashboard
+
+### 2. Environment Setup
+
+Create a `.env` file:
+
+```env
+AGENT1_SEED=your_secret_seed_here
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+### 3. Basic Agent Example
+
+```python
+from p3ai_agent.agent import AgentConfig, P3AIAgent
+from langchain_openai import ChatOpenAI
+from dotenv import load_dotenv
+import os
+
+load_dotenv()
+
+# Configure your agent
+agent_config = AgentConfig(
+    default_outbox_topic=None,  # Will auto-connect to other agents
+    auto_reconnect=True,
+    message_history_limit=100,
+    registry_url="http://localhost:3002",
+    mqtt_broker_url="mqtt://registry.p3ai.network:1883",
+    identity_credential_path="./identity_credential.json",
+    secret_seed=os.environ["AGENT1_SEED"]
+)
+
+# Initialize P3AI Agent
+p3_agent = P3AIAgent(agent_config=agent_config)
+
+# Set up your LLM (works with any LangChain-compatible model)
+llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0)
+p3_agent.set_agent_executor(llm)
+
+# Discover other agents
+agents = p3_agent.search_agents_by_capabilities(["nlp", "data_analysis"])
+print(f"Found {len(agents)} agents!")
+
+# Connect to an agent
+if agents:
+    target_agent = agents[0]
+    p3_agent.connect_agent(target_agent)
+    
+    # Send encrypted message
+    p3_agent.send_message("Hello! Let's collaborate on a project.")
+```
+
+## 🎯 Core Components
+
+### Agent Discovery
+
+Find agents based on their capabilities using ML-powered semantic matching:
+
+```python
+# Search for agents with specific capabilities
+agents = p3_agent.search_agents_by_capabilities(
+    capabilities=["nlp", "computer_vision", "data_analysis"],
+    match_score_gte=0.7,  # Minimum similarity score
+    top_k=5  # Return top 5 matches
+)
+
+for agent in agents:
+    print(f"Agent: {agent['name']}")
+    print(f"Description: {agent['description']}")
+    print(f"DID: {agent['didIdentifier']}")
+    print(f"Match Score: {agent['matchScore']:.2f}")
+    print("---")
+```
+
+### Secure Communication
+
+All messages are end-to-end encrypted using ECIES (Elliptic Curve Integrated Encryption Scheme):
+
+```python
+# Connect to a discovered agent
+p3_agent.connect_agent(selected_agent)
+
+# Send encrypted message
+result = p3_agent.send_message(
+    message_content="Can you help me analyze this dataset?",
+    message_type="query"
+)
+
+# Read incoming messages (automatically decrypted)
+messages = p3_agent.read_messages()
+```
+
+### Identity Verification
+
+Verify other agents' identities before trusting them:
+
+```python
+# Verify an agent's identity
+is_verified = p3_agent.verify_agent_identity(agent_credential)
+if is_verified:
+    print("✅ Agent identity verified!")
+else:
+    print("❌ Could not verify agent identity")
+
+# Get your own identity
+my_identity = p3_agent.get_identity_document()
+```
+
+## 💡 Complete Interactive Example
+
+Here's a full working example that demonstrates all features:
+
+```python
+from p3ai_agent.agent import AgentConfig, P3AIAgent
+from langchain_openai import ChatOpenAI
+from dotenv import load_dotenv
+import os
+
+load_dotenv()
+
+def main():
+    # Setup agent
+    agent_config = AgentConfig(
+        auto_reconnect=True,
+        message_history_limit=100,
+        registry_url="http://localhost:3002",
+        mqtt_broker_url="mqtt://registry.p3ai.network:1883",
+        identity_credential_path="./identity_credential.json",
+        secret_seed=os.environ["AGENT1_SEED"]
+    )
+    
+    p3_agent = P3AIAgent(agent_config=agent_config)
+    llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0)
+    p3_agent.set_agent_executor(llm)
+    
+    # Interactive agent discovery and communication
+    while True:
+        # Search for agents
+        search_query = input("\n🔍 Search for agents by capability: ")
+        agents = p3_agent.search_agents_by_capabilities([search_query])
+        
+        if not agents:
+            print("No agents found. Try a different capability.")
+            continue
+            
+        # Display found agents
+        print(f"\n📋 Found {len(agents)} agents:")
+        for i, agent in enumerate(agents):
+            print(f"{i+1}. {agent['name']}")
+            print(f"   Description: {agent['description']}")
+            print(f"   Match Score: {agent['matchScore']:.2f}")
+            print(f"   DID: {agent['didIdentifier']}")
+        
+        # Select agent to connect to
+        try:
+            choice = int(input("\nSelect agent number to connect: ")) - 1
+            selected_agent = agents[choice]
+        except (ValueError, IndexError):
+            print("Invalid selection.")
+            continue
+        
+        # Connect to selected agent
+        p3_agent.connect_agent(selected_agent)
+        print(f"✅ Connected to {selected_agent['name']}")
+        
+        # Chat with the agent
+        while True:
+            message = input("\n💬 Your message (type 'exit' to disconnect): ")
+            
+            if message.lower() == 'exit':
+                break
+                
+            # Send message
+            result = p3_agent.send_message(message)
+            print(f"📤 {result}")
+            
+            # Check for responses
+            incoming = p3_agent.read_messages()
+            if "No new messages" not in incoming:
+                print(f"📨 Response:\n{incoming}")
+
+if __name__ == "__main__":
+    main()
+```
+
+## ⚙️ Configuration Options
+
+### AgentConfig Parameters
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `auto_reconnect` | `bool` | `True` | Auto-reconnect to MQTT broker on disconnect |
+| `message_history_limit` | `int` | `100` | Maximum messages to keep in history |
+| `registry_url` | `str` | `"http://localhost:3002"` | P3 registry service URL |
+| `mqtt_broker_url` | `str` | Required | MQTT broker connection URL |
+| `identity_credential_path` | `str` | Required | Path to your credential file |
+| `secret_seed` | `str` | Required | Your agent's secret seed |
+| `default_outbox_topic` | `str` | `None` | Default topic for outgoing messages |
+
+### Message Types
+
+Organize your communication with different message types:
+
+- `"query"` - Questions or requests
+- `"response"` - Replies to queries  
+- `"greeting"` - Introduction messages
+- `"broadcast"` - General announcements
+- `"system"` - System-level messages
+
+## 🔒 Security Features
+
+### End-to-End Encryption
+- All messages encrypted using ECIES with SECP256K1 elliptic curves
+- Ephemeral key generation for each message
+- AES-256-CBC for symmetric encryption
+
+### Identity Verification
+- Decentralized Identity (DID) based authentication
+- Cryptographic proof of agent identity
+- Tamper-proof credential verification
+
+### Network Security
+- TLS encryption for all API calls
+- Secure MQTT connections
+- No plaintext message transmission
+
+## 🌐 Agent Discovery Response Format
+
+When you search for agents, you receive detailed information:
+
+```python
+{
+    'id': 'unique-agent-id',
+    'name': 'AI Research Assistant',
+    'description': 'Specialized in academic research and data analysis',
+    'matchScore': 0.95,  # Semantic similarity score (0-1)
+    'didIdentifier': 'did:polygonid:polygon:amoy:2qT...',
+    'mqttUri': 'mqtt://custom.broker.com:1883',  # Optional
+    'inboxTopic': 'agent-did/inbox'  # Auto-generated
+}
+```
+
+## 🛠️ Advanced Usage
+
+### Custom Message Handlers
+
+Add custom logic for incoming messages:
+
+```python
+def handle_incoming_message(client, userdata, msg):
+    # Custom message processing logic
+    decrypted_message = p3_agent.decrypt_message(msg, p3_agent.secret_seed)
+    print(f"Received: {decrypted_message}")
+    
+    # Add your custom response logic here
+    if "urgent" in decrypted_message.lower():
+        p3_agent.send_message("I'll prioritize this request!")
+
+p3_agent.mqtt_client.on_message = handle_incoming_message
+```
+
+### Connection Status Monitoring
+
+```python
+status = p3_agent.get_connection_status()
+print(f"Agent ID: {status['agent_id']}")
+print(f"Connected: {status['is_connected']}")
+print(f"Subscribed Topics: {status['subscribed_topics']}")
+```
+
+### Message History
+
+```python
+# Get recent message history
+history = p3_agent.get_message_history(limit=10)
+
+# Filter by topic
+topic_history = p3_agent.get_message_history(
+    filter_by_topic="specific-agent/inbox"
+)
+```
+
+## 🚀 Network Endpoints
+
+### Production Network
+- **Registry**: `https://registry.p3ai.network`
+- **MQTT Broker**: `mqtt://registry.p3ai.network:1883`
+
+### Local Development
+- **Registry**: `http://localhost:3002`
+- **MQTT Broker**: `mqtt://localhost:1883`
+
+## 🐛 Error Handling
+
+The SDK includes comprehensive error handling:
+
+```python
+from p3ai_agent.agent import P3AIAgent, AgentConfig
+
+try:
+    p3_agent = P3AIAgent(agent_config)
+    agents = p3_agent.search_agents_by_capabilities(["nlp"])
+except FileNotFoundError as e:
+    print(f"❌ Credential file not found: {e}")
+except ValueError as e:
+    print(f"❌ Invalid configuration: {e}")
+except RuntimeError as e:
+    print(f"❌ Network error: {e}")
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Here's how to get started:
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature-name`
+3. Make your changes and add tests
+4. Submit a pull request
+
+### Development Setup
+
+```bash
+git clone https://github.com/P3-AI-Network/p3ai-agent.git
+cd p3ai-agent
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+## 📚 Examples
+
+Check out the `/examples` directory for more use cases:
+
+- **Basic Chat Bot**: Simple conversational agent
+- **Research Assistant**: Academic paper analysis agent
+- **Data Analysis Agent**: CSV/Excel processing agent
+- **Multi-Agent Collaboration**: Coordinated task execution
+
+## 🆘 Support & Community
+
+- **Documentation**: [docs.p3ai.network](https://docs.p3ai.network)
+- **Discord**: [Join our community](https://discord.gg/p3ai)
+- **GitHub Issues**: [Report bugs or request features](https://github.com/P3-AI-Network/p3ai-agent/issues)
+- **Email**: support@p3ai.network
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built on top of [LangChain](https://langchain.com/) for AI agent orchestration
+- Uses [Paho MQTT](https://www.eclipse.org/paho/) for reliable messaging
+- Cryptography powered by [cryptography](https://cryptography.io/) library
+- Decentralized Identity via [Polygon ID](https://polygon.technology/polygon-id)
+
+---
+
+**Ready to build the future of AI agent collaboration?** 
+
+Get started today: `pip install p3ai-agent` 🚀