Skip to main content

Fivccliche

A production-ready, multi-user backend framework designed specifically for AI agents. Built with FastAPI and SQLModel for high-performance, type-safe async operations that handle concurrent AI agent requests at scale.

✨ Features

  • AI Agent Backend - Purpose-built for multi-user AI agent interactions and orchestration
  • FastAPI - Modern, fast web framework for building high-performance APIs with Python 3.10+
  • SQLModel - SQL ORM combining SQLAlchemy and Pydantic for type-safe database operations
  • Async/Await - Full async support for handling concurrent AI agent requests at scale
  • Type Safety - Built-in type hints with Pydantic 2.0 validation for reliable data handling
  • Multi-User Support - Designed for managing multiple AI agents with proper isolation and access control
  • Scheduled Tasks - APScheduler-based per-module scheduled job support, wired through IModule.mount
  • Testing - Pytest with async support for comprehensive test coverage
  • Code Quality - Black, Ruff, and MyPy configured for professional code standards
  • Package Management - uv for fast, reliable dependency management

🚀 Quick Start

Prerequisites

  • Python 3.10 or higher
  • uv package manager (install)

Installation

# Clone the repository
git clone https://github.com/MindFiv/FivcCliche.git
cd FivcCliche

# Install production dependencies
uv pip install -e .

# Or install with development tools
uv pip install -e ".[dev]"

Using the CLI

The easiest way to run FivcCliche is using the built-in CLI:

python -m fivccliche.cli migrate            # Create missing tables
python -m fivccliche.cli createsuperuser    # Interactive admin user
python -m fivccliche.cli run                # Start the server
python -m fivccliche.cli jobs list          # List scheduled jobs
python -m fivccliche.cli info               # Show project information
python -m fivccliche.cli clean              # Clean temporary files and cache

Visit http://localhost:8000/docs for interactive API documentation.

Configuration APIs

Authenticated users can manage user-scoped AI agent resources under /configs/. Superusers create global configs (user_uuid = null) that regular users can read but not update or delete.

  • /configs/embeddings/ - embedding provider/model configs
  • /configs/models/ - LLM provider/model configs with id, description, provider, model, api_key, base_url, temperature, max_tokens, optional nullable enable_thinking, user_uuid, updated_at, and updated_user_uuid fields. enable_thinking = null leaves provider behavior unchanged, true enables provider-supported thinking output, and false disables it.
  • /configs/agents/ - agent configs that compose models, tools, and skills
  • /configs/tools/ - tool configs, including MCP/function transports
  • /configs/skills/ - reusable skill configs and resources
  • /configs/questions/ - reusable user question configs with id, question, optional answer, is_active, user_uuid, updated_at, and updated_user_uuid fields; list with ?is_active=true or ?is_active=false to filter by active state

python -m fivccliche.cli migrate creates missing tables but does not alter existing tables. Existing databases created before user_llm.enable_thinking was added need a manual nullable boolean column on user_llm or a table rebuild.

CLI Options

# Custom host and port
python -m fivccliche.cli run --host 127.0.0.1 --port 9000

# Production mode (no auto-reload)
python -m fivccliche.cli run --no-reload

# Test configuration without running
python -m fivccliche.cli run --dry-run

# Verbose output
python -m fivccliche.cli run --verbose

📚 Documentation

For detailed information, see the documentation in the docs/ folder:

🛠️ Development

CLI Commands

make format  # Format code with Black
make lint    # Lint with Ruff
make check   # Run all checks (format, lint, type check)

Run Tests

pytest
pytest -v --cov=src  # With coverage

Code Quality

black src/ tests/      # Format code
ruff check src/ tests/ # Lint code
mypy src/              # Type check

Project Structure

fivccliche/
├── pyproject.toml
├── src/fivccliche/
│   ├── cli.py
│   ├── services/
│   ├── utils/
│   ├── settings/
│   └── modules/
│       ├── users/
│       ├── agent_configs/
│       ├── agent_chats/
│       └── agent_memories/
├── tests/
└── docs/

📦 Dependencies

Production Core: FastAPI, SQLModel, Uvicorn, Pydantic, SQLAlchemy, APScheduler

CLI & Output: Typer, Rich, python-dotenv

Component System: fivcglue, fivcplayground

Development: Pytest, Black, Ruff, MyPy, Coverage

See pyproject.toml for complete dependency list and versions.

📄 License

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

👤 Author

Charlie Zhang (sunnypig2002@gmail.com)

🔗 Links

Download files

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

Source Distribution

fivccliche-0.1.84.tar.gz (116.8 kB view details)

Uploaded Source

Built Distribution

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

fivccliche-0.1.84-py3-none-any.whl (65.2 kB view details)

Uploaded Python 3

File details

Details for the file fivccliche-0.1.84.tar.gz.

File metadata

  • Download URL: fivccliche-0.1.84.tar.gz
  • Upload date:
  • Size: 116.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.10

File hashes

Hashes for fivccliche-0.1.84.tar.gz
Algorithm Hash digest
SHA256 3e66c358d467c0f25c92cb5faa667278c0ca4ef19080e5c7c59ecbe7df3cd53e
MD5 b8bd7a73b5e5c0c2d29851f78876e127
BLAKE2b-256 a1c6d561f7b9aa4dedea50cb515d890de9e0837892eb39004776e06481a124aa

See more details on using hashes here.

File details

Details for the file fivccliche-0.1.84-py3-none-any.whl.

File metadata

File hashes

Hashes for fivccliche-0.1.84-py3-none-any.whl
Algorithm Hash digest
SHA256 c77f54fa59ad931733dfbb54499db9ecd95b457ca7caf7da12053eafeaa75214
MD5 5845f2c6061a676c61ecab30d776a722
BLAKE2b-256 46a0c56ed8648b8ad5c95d09166a900e01aca49fd321e78ad55f95ece7a7571b

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.89

2 files

0.1.88

2 files

0.1.87

2 files

0.1.86

2 files

0.1.85

2 files

This release

0.1.84 This release

2 files

0.1.83

2 files

0.1.82

2 files

0.1.81

2 files

0.1.80

2 files

0.1.79

2 files

0.1.78

2 files

0.1.77

2 files

0.1.76

2 files

0.1.74

2 files

0.1.73

2 files

0.1.72

2 files

0.1.71

2 files

0.1.70

2 files

0.1.69

2 files

0.1.68

2 files

0.1.67

2 files

0.1.66

2 files

0.1.65

2 files

0.1.64

2 files

0.1.63

2 files

0.1.62

2 files

0.1.61

2 files

0.1.60

2 files

0.1.59

2 files

0.1.58

2 files

0.1.57

2 files

0.1.56

2 files

0.1.55

2 files

0.1.54

2 files

0.1.53

2 files

0.1.52

2 files

0.1.51

2 files

0.1.50

2 files

0.1.49

2 files

0.1.48

2 files

0.1.47

2 files

0.1.46

2 files

0.1.45

2 files

0.1.44

2 files

0.1.43

2 files

0.1.42

2 files

0.1.41

2 files

0.1.33

2 files

0.1.32

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page