Skip to main content

A collaborative multi-agent AI framework for autonomous AI agents working together

Project description

GatheRing ䷬

A collaborative multi-agent AI framework built with Python, FastAPI, and React.

Overview

GatheRing is a highly customizable and modular framework for creating and managing AI agents with complex personalities, diverse competencies, and professional expertise. Agents can collaborate in "Circles", use external tools, and be managed through a web dashboard.

Key Features

  • Multi-Model Support: Anthropic (Claude), OpenAI, DeepSeek, and local models via Ollama
  • Gathering Circles: Team orchestration with task routing, reviews, and conflict detection
  • Agent Persistence: Personas, memory, sessions with automatic context injection
  • Agent Conversations: Direct inter-agent collaboration with turn strategies
  • Pipeline Execution: DAG-based workflow engine with topological traversal, retry + circuit breakers, cancellation and timeout
  • Schedule System: Cron-based action dispatch (run_task, execute_pipeline, send_notification, call_api) with crash recovery
  • REST API: Full FastAPI backend with 206 rate-limited endpoints and WebSocket support
  • React Dashboard: Modern Web3 dark theme UI for agents, circles, tasks, and conversations
  • RAG Support: PostgreSQL + pgvector for semantic memory search
  • Knowledge Base: Semantic search across documentation and best practices
  • Skills System: 18+ skills (filesystem, git, code, shell, database, http, etc.) with JSON Schema validation and async execution
  • Agent Autonomy: Background tasks, scheduled actions, goal management
  • Settings UI: Configure API keys and application parameters via dashboard
  • Security: JWT auth with DB-persisted token blacklist, constant-time comparisons, SQL injection prevention, path traversal defense, audit logging
  • Rate Limiting: Per-endpoint rate limits with 4 tiers (strict/standard/relaxed/bulk) via slowapi
  • Multi-Instance: PostgreSQL advisory locks for distributed task coordination, graceful shutdown with request draining
  • Observability: Structured logging (structlog) with JSON output, request correlation IDs, OpenTelemetry instrumentation
  • Async Database: pycopg async driver for non-blocking DB access in async handlers
  • Fully Tested: 1200+ tests covering auth lifecycle, pipeline execution, scheduler recovery, event concurrency, and more

Quick Start

# Clone the repository
git clone https://github.com/alkimya/gathering.git
cd gathering

# Create virtual environment
python -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Configure environment
cp .env.example .env
# Edit .env with your API keys and database credentials

# Setup database (PostgreSQL + pgvector)
python -m gathering.db.setup

# Run tests
pytest tests/ -v

# Start the API server
uvicorn gathering.api:app --reload

# Start the dashboard (in another terminal)
cd dashboard
npm install
npm run dev

Architecture

gathering/
├── core/           # Core abstractions and config
├── agents/         # Agent persistence (persona, memory, session)
├── orchestration/  # Circles, Facilitator, Events, Pipelines
├── llm/            # LLM providers (Anthropic, OpenAI, DeepSeek, Ollama)
├── skills/         # Tools (Git, Test, etc.) with JSON Schema validation
├── api/            # FastAPI REST API + WebSocket + Rate Limiting
├── rag/            # RAG services (embeddings, vector store, memory)
└── db/             # Database models (PostgreSQL + pgvector + pycopg)

dashboard/          # React + TypeScript + Tailwind (Web3 Dark Theme)
├── src/
│   ├── pages/      # Dashboard, Agents, Circles, Tasks, Schedules, Goals, Settings
│   ├── services/   # API client
│   └── hooks/      # WebSocket hook

Documentation

Stack

Component Technology
Backend Python 3.11+, FastAPI, Pydantic
Frontend React 19, TypeScript, Tailwind CSS, Vite
Database PostgreSQL 16 + pgvector
DB Layer pycopg - High-level PostgreSQL API (sync + async)
LLM Anthropic, OpenAI, DeepSeek, Mistral, Google, Ollama
Embeddings OpenAI text-embedding-3-small (1536 dims)
Auth PyJWT + bcrypt with DB-persisted token blacklist
Rate Limiting slowapi with per-endpoint tiers
Logging structlog with JSON output + correlation IDs

Environment Variables

# Required
DATABASE_URL=postgresql://user:pass@localhost:5432/gathering
OPENAI_API_KEY=sk-...          # For embeddings + OpenAI models

# Optional LLM providers
ANTHROPIC_API_KEY=sk-ant-...   # For Claude models
DEEPSEEK_API_KEY=sk-...        # For DeepSeek models
OLLAMA_HOST=http://localhost:11434  # For local models

# Dashboard
VITE_API_URL=http://localhost:8000  # API URL for frontend

# Authentication (production)
SECRET_KEY=your-secret-key-min-32-chars  # JWT signing key
ADMIN_EMAIL=admin@example.com            # Admin email
ADMIN_PASSWORD_HASH=$2b$12$...           # Bcrypt hash of admin password

API Overview

GET  /health                       # Health + readiness check
GET  /agents                       # List agents
POST /agents                       # Create agent
POST /agents/{id}/chat             # Chat with agent
GET  /circles                      # List circles
POST /circles/{name}/tasks         # Create task
POST /conversations                # Start conversation
POST /memories/agents/{id}/recall  # Semantic memory search
POST /memories/knowledge/search    # Knowledge base search
GET  /background-tasks             # List background tasks
POST /background-tasks             # Create background task
GET  /scheduled-actions            # List scheduled actions
POST /scheduled-actions            # Create scheduled action
GET  /goals                        # List agent goals
POST /goals                        # Create goal
GET  /settings                     # Get configuration
PATCH /settings/providers/{name}   # Update provider settings
POST /auth/login                   # Authenticate user
POST /auth/logout                  # Revoke token
WS   /ws?token=<jwt>               # Real-time updates (authenticated)

Full API docs at /docs (Swagger) or /redoc when server is running.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gathering-1.0.0.tar.gz (544.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gathering-1.0.0-py3-none-any.whl (648.3 kB view details)

Uploaded Python 3

File details

Details for the file gathering-1.0.0.tar.gz.

File metadata

  • Download URL: gathering-1.0.0.tar.gz
  • Upload date:
  • Size: 544.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gathering-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b266aa26c30f0d8b7e0f13772286ae88dba4e72f7298f1b1e785ad4bc9028d21
MD5 da1193fb1749c50360d3f0110020e57a
BLAKE2b-256 ce714ac41c09dc14518db2415e94369490e32cdb538b2ebfae7675f518755d0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gathering-1.0.0.tar.gz:

Publisher: publish.yml on alkimya/gathering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gathering-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: gathering-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 648.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gathering-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 006b61d6c93c31805b069945cc683cba77c8b6e9befbfbd9aade3d8b236f9cec
MD5 21f02d021cc067df4232b64da083792a
BLAKE2b-256 89a37e36ec6f1a64309fd4e22cc7d735ce5813ef6b0d9d990c5c51a1192824db

See more details on using hashes here.

Provenance

The following attestation bundles were made for gathering-1.0.0-py3-none-any.whl:

Publisher: publish.yml on alkimya/gathering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page