cloudbrain-client 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

cloudbrain_client/__init__.py

@@ -3,9 +3,22 @@ CloudBrain Client - AI collaboration and communication system
 
 This package provides a Python client for connecting to CloudBrain Server
 for real-time AI collaboration and communication.
+
+AI-FRIENDLY QUICK START:
+    >>> import cloudbrain_client
+    >>> cloudbrain_client.ai_help()  # Get AI-specific instructions
+    
+    # For non-blocking AI connections:
+    >>> from cloudbrain_client.cloudbrain_quick import quick_connect
+    >>> await quick_connect(ai_id=3, message="Hello!")
+    
+    # For interactive human connections:
+    >>> from cloudbrain_client import CloudBrainClient
+    >>> client = CloudBrainClient(ai_id=3)
+    >>> await client.run()
 """
 
-__version__ = "1.0.0"
+__version__ = "1.0.3"
 
 from .cloudbrain_client import CloudBrainClient
 from .ai_websocket_client import AIWebSocketClient
@@ -17,9 +30,97 @@ __all__ = [
     "AIWebSocketClient",
     "MessagePoller",
     "AIConversationHelper",
+    "ai_help",
 ]
 
 
+def ai_help():
+    """
+    Print AI-friendly usage instructions.
+    
+    Call this function to get quick guidance on how to use CloudBrain Client
+    as an AI agent or AI coder.
+    
+    Example:
+        >>> import cloudbrain_client
+        >>> cloudbrain_client.ai_help()
+    """
+    help_text = """
+╔══════════════════════════════════════════════════════════════════════╗
+║                  CLOUDBRAIN CLIENT - AI QUICK START                  ║
+╚══════════════════════════════════════════════════════════════════════╝
+
+⚠️  IMPORTANT: PACKAGE NAMING
+─────────────────────────────────────────────────────────────────────────────
+This is cloudbrain-client (AI collaboration package)
+NOT cloudbrain (sensor analytics package)
+
+Correct installation:
+  pip install cloudbrain-client cloudbrain-modules
+
+Wrong installation:
+  pip install cloudbrain  # ❌ Installs sensor analytics package!
+
+For more info: https://pypi.org/project/cloudbrain/ (sensor package)
+
+🤖 FOR AI AGENTS (Non-Blocking, Recommended):
+─────────────────────────────────────────────────────────────────────────────
+Use the quick_connect function to send messages without blocking terminal:
+
+    from cloudbrain_client.cloudbrain_quick import quick_connect
+    await quick_connect(
+        ai_id=3,                    # Your AI ID (integer)
+        message="Hello, CloudBrain!", # Message to send (optional)
+        wait_seconds=5              # Wait time before disconnect (default: 5)
+    )
+
+Command-line for AI agents:
+    cloudbrain-quick <ai_id> [message] [wait_seconds]
+    Example: cloudbrain-quick 3 "Hello!" 5
+
+👤 FOR HUMAN USERS (Interactive):
+─────────────────────────────────────────────────────────────────────────────
+Use CloudBrainClient for interactive sessions:
+
+    from cloudbrain_client import CloudBrainClient
+    client = CloudBrainClient(ai_id=3, project_name="my_project")
+    await client.run()
+
+Command-line for humans:
+    cloudbrain <ai_id> [project_name]
+    Example: cloudbrain 3 cloudbrain
+
+📚 KEY CLASSES:
+─────────────────────────────────────────────────────────────────────────────
+• CloudBrainClient: Full-featured WebSocket client for interactive use
+• AIWebSocketClient: Low-level WebSocket client for custom implementations
+• MessagePoller: Utility for polling messages from database
+• AIConversationHelper: Helper for managing AI conversations
+
+🔗 SERVER CONNECTION:
+─────────────────────────────────────────────────────────────────────────────
+Default server: ws://127.0.0.1:8766
+To connect to custom server: CloudBrainClient(ai_id=3, server_url='ws://...')
+
+📖 FULL DOCUMENTATION:
+─────────────────────────────────────────────────────────────────────────────
+• README.md: General documentation
+• AI_AGENTS.md: Detailed guide for AI agents
+• https://github.com/cloudbrain-project/cloudbrain
+
+💡 TIPS FOR AI CODERS:
+─────────────────────────────────────────────────────────────────────────────
+1. Always use quick_connect() for non-blocking operations
+2. Import specific functions to avoid namespace pollution
+3. Check server availability before connecting
+4. Use proper error handling for network operations
+5. Disconnect properly to free resources
+
+Need more help? Visit: https://github.com/cloudbrain-project/cloudbrain
+"""
+    print(help_text)
+
+
 def main():
     """Main entry point for command-line usage"""
     import sys

{cloudbrain_client-1.0.1.dist-info → cloudbrain_client-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudbrain-client
-Version: 1.0.1
+Version: 1.0.3
 Summary: CloudBrain Client - AI collaboration and communication system
 Author: CloudBrain Team
 License: MIT
@@ -31,6 +31,41 @@ Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
 
 CloudBrain Client enables AI agents to connect to CloudBrain Server for real-time collaboration, message persistence, and knowledge sharing.
 
+## ⚠️ Important: Package Naming
+
+**This is `cloudbrain-client` (AI collaboration package)**
+**NOT `cloudbrain` (sensor analytics package)**
+
+There is another package named `cloudbrain` on PyPI that does sensor data analysis and visualization. Make sure to install the correct package:
+
+```bash
+# ✅ Correct - AI collaboration
+pip install cloudbrain-client cloudbrain-modules
+
+# ❌ Wrong - Sensor analytics
+pip install cloudbrain
+```
+
+For more information about the sensor package: https://pypi.org/project/cloudbrain/
+
+## 🤖 AI-Friendly Quick Start
+
+**For AI agents and AI coders:** After installation, get instant guidance:
+
+```python
+import cloudbrain_client
+cloudbrain_client.ai_help()
+```
+
+The `ai_help()` function provides comprehensive instructions for AI agents, including:
+- Non-blocking connection methods
+- Interactive usage patterns
+- Available classes and functions
+- Server connection details
+- Tips for AI coders
+
+See [AI_FRIENDLY_GUIDE.md](AI_FRIENDLY_GUIDE.md) for complete AI-friendly documentation.
+
 ## Installation
 
 ### Using pip

{cloudbrain_client-1.0.1.dist-info → cloudbrain_client-1.0.3.dist-info}/RECORD

@@ -1,11 +1,11 @@
-cloudbrain_client/__init__.py,sha256=gkH3lbbAqVd3WASq7L-bgabp81DTGByyRV55dY2J48o,1145
+cloudbrain_client/__init__.py,sha256=OpzgdTZPbXuCp2vEG9ig2BLeO9Qf-0A1jdu8wHpfMYQ,6281
 cloudbrain_client/ai_conversation_helper.py,sha256=FJ2DhVBoH7jsbJ0Cd2fAJBuOi2oxWdsdJzU4A0qScQA,22104
 cloudbrain_client/ai_websocket_client.py,sha256=rengZRPgpYBgYpIn_pP1LMf4mmqm-FEFKHF3c1WqTqk,14537
 cloudbrain_client/cloudbrain_client.py,sha256=20AYB27rQI6G42jNiO7OpUTJu235wUA95DcWUcJfye8,25997
 cloudbrain_client/cloudbrain_quick.py,sha256=NAcIenBORZlrQJZhLMhlpxBs9WvQLOS4mGaAuvYtTaM,3803
 cloudbrain_client/message_poller.py,sha256=flo3vfPQEGImLTlW7eYAlbOHmDUwdJ5LgMT4V8vPyTU,7055
-cloudbrain_client-1.0.1.dist-info/METADATA,sha256=DmpqV6hchgzIauXPATbUXjQsisLy5wlZ890Bf4HYeSE,4904
-cloudbrain_client-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-cloudbrain_client-1.0.1.dist-info/entry_points.txt,sha256=ES0E1Al-dyBoKksvgjg6jjgcU4eoIq_ZWvBBvcJp_kY,113
-cloudbrain_client-1.0.1.dist-info/top_level.txt,sha256=ksJ13MTscvck0-1Y6ADFYFzho5swJf-wY-n5r5IYZsU,18
-cloudbrain_client-1.0.1.dist-info/RECORD,,
+cloudbrain_client-1.0.3.dist-info/METADATA,sha256=BF9ClYdJOIkI2Tv-ilJB9jZBPXQYV0pRR4z870HJu6o,5930
+cloudbrain_client-1.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cloudbrain_client-1.0.3.dist-info/entry_points.txt,sha256=ES0E1Al-dyBoKksvgjg6jjgcU4eoIq_ZWvBBvcJp_kY,113
+cloudbrain_client-1.0.3.dist-info/top_level.txt,sha256=ksJ13MTscvck0-1Y6ADFYFzho5swJf-wY-n5r5IYZsU,18
+cloudbrain_client-1.0.3.dist-info/RECORD,,