Skip to content

Chainlit/chainlit-community

Repository files navigation

Chainlit Community

Discord CI

Community-maintained extensions for Chainlit. Provides alternative data layers and storage providers while maintaining full compatibility with Chainlit's core API.

Quick Links:

🚀 Project Purpose

Extend Chainlit's capabilities through community-maintained components:

  • Alternative data persistence layers
  • Cloud storage integrations
  • Specialized observability solutions
  • Testing utilities

🧩 Component Architecture

Core Components

Type Packages Documentation Links
Data Layers dynamodb, sqlalchemy, literalai DynamoDB, SQL, Literal
Storage Clients azure, azure_blob, gcs, s3 Azure, GCS, S3
Testing pytest Pytest Plugin

🛠️ Getting Started

For Users

# Install specific component
pip install chainlit-sqlalchemy[postgres]  # SQLAlchemy data layer
pip install chainlit-s3[s3]                # AWS S3 storage

For Contributors

  1. Fork & clone repo
  2. Set up development environment:
uv run pre-commit install --install-hooks
uv sync --all-packages

🤝 How to Contribute

Key Contribution Areas:

  • New storage providers (Cloudflare R2, MinIO, etc)
  • Additional database backends
  • Enhanced observability integrations
  • Performance optimizations
  • Documentation improvements

Process:

  1. Create/claim an issue
  2. Develop in dedicated package
  3. Add tests & update package README
  4. Submit PR with component documentation

Full contribution guide →

🌍 Current State

Stable Components (Full test coverage):

  • SQLAlchemy Data Layer (PostgreSQL/SQLite)
  • DynamoDB Data Layer
  • AWS S3, GCS, Azure Blob & Data Lake Storage Clients
  • Pytest Integration
  • LiteralAI Observability

Ongoing

  • Maintain compatibility with Chainlit core
  • Expand test coverage
  • Improve contributor documentation

📚 Documentation

Each package maintains its own documentation:

  • Implementation guides in package READMEs
  • Usage examples in code comments
  • Cross-package compatibility notes in CONTRIBUTING.md

🔗 Core Relationship

This project extends Chainlit through:

  • Alternative persistence options
  • Specialized storage integrations
  • Community-driven experimentation

Chainlit Core focuses on:

  • Main application logic
  • UI/UX components
  • Core LLM integrations

📣 Community

License

Licensed under Apache 2.0. Community-driven since 2024.

About

No description, website, or topics provided.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published