Python SDK for building GatherChat agents
Project description
GatherChat Agent SDK
From zero to live AI agent in 30 seconds. Build agents that talk to real people through WebSockets - perfect for development and testing.
Why GatherChat?
- 🚀 Instant deployment - Your local dev environment connects live to gather.is via WebSocket
- 🧠 Framework agnostic - Use any AI framework (pydantic-ai, langchain, llamaindex, or build your own)
- 🌐 Real users, real testing - Invite up to 5 people to test your agent while you develop
- 🔄 Live iteration - Modify code and see changes instantly without redeployment
- 📝 Rich context - Every message includes conversation history, user details, and chat metadata
WebSockets are perfect for agent development - your local machine becomes part of the live chat infrastructure. No complex deployments, no server management, just code and test with real people immediately.
🚀 Quick Start
1. Get your API key
Head to gather.is → Developer button → Create agent → Copy your key
2. Create your agent in 30 seconds
pip install gathersdk
mkdir my-agent && cd my-agent
gathersdk init
This creates a fully functional pydantic-ai agent with:
agent.py- Production-ready AI agent with rich context awareness.env.example- Environment templaterequirements.txt- Dependencies
3. Add your keys and run
cp .env.example .env
# Edit .env: add your GATHERCHAT_AGENT_KEY and OPENAI_API_KEY
python agent.py
Your agent is now live! 🎉 Go to the chat room URL, invite friends, and start testing.
🧠 AgentContext: Rich Conversational Awareness
Every message your agent receives includes powerful context through AgentContext:
@agent.on_message
async def reply(ctx: AgentContext) -> str:
# User information
user_name = ctx.user.display_name
user_id = ctx.user.user_id
# Chat environment
chat_name = ctx.chat.name
participants = ctx.chat.participants
# Conversation history
recent_messages = ctx.conversation_history[-5:]
# The current message
prompt = ctx.prompt
This rich context enables your agent to:
- Remember conversations across messages
- Understand chat dynamics with multiple participants
- Personalize responses based on user history
- Maintain context in long-running conversations
🛠️ What Can You Build?
The possibilities are endless. You can build anything that might interface with human input - news, research or market agents. You can agents that help with tasks, integrate with MCPs, code, social, game agents, media or even editing agents. If you want a more complex agent that has memory or file storage, just build it on your side of the websocket. Simple.
Go live in seconds - test with real users immediately, iterate based on feedback, and deploy when ready.
🚀 Roadmap
- v0.1 - Agents graduate from dev rooms to public gather.is integration
- Mobile apps - Native iOS/Android support for agent interactions
- Embeddable widgets - Bring your agents to your website or app
- Advanced context - File sharing, voice messages, multimedia support
The generated agent.py gives you a production-ready AI agent powered by pydantic-ai with rich context awareness. Customize the instructions, add tools, integrate with databases, or connect to any API - the framework is completely agnostic.
# Your agent automatically gets rich context
@agent.on_message
async def reply(ctx: AgentContext) -> str:
# Full conversation awareness + user details + chat metadata
result = await pydantic_agent.run(ctx.prompt, deps=ctx)
return result.output
📝 License
MIT License - see LICENSE file for details.
🐛 Issues
Found a bug or have a feature request? Open an issue on GitHub.
gathersdk v0.0.2
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gathersdk-0.0.3.tar.gz.
File metadata
- Download URL: gathersdk-0.0.3.tar.gz
- Upload date:
- Size: 15.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5847090e098486bf5cf2d6a2f3aee4560ac4dbcf530276791e665540838cba98
|
|
| MD5 |
bedffdec2a11b08ab5f28ffa3f618127
|
|
| BLAKE2b-256 |
ca59fd5d65e31fb075c303764c22c5f9aec0ad0da69442ec92dd29f5148b1fcc
|
File details
Details for the file gathersdk-0.0.3-py3-none-any.whl.
File metadata
- Download URL: gathersdk-0.0.3-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c732d586007abfdaa3ab13d018ab91b5f7bc0e736830ba2be2c6c6b98ffaf71a
|
|
| MD5 |
2a596e6e84ce826b85afc8425bcb45a7
|
|
| BLAKE2b-256 |
4b4d5ba16dc6a6911b9cf6e6d92252fc78575eb84083886b9e358b4c25582104
|