gochat-python 0.1.0.dev2

A modern, responsive chat application framework built with FastAPI, HTMX, Tailwind CSS, and Google GenAI (Gemini).

GoChat 🚀

GoChat is a modern, responsive Python chat application framework built on FastAPI, HTMX, Tailwind CSS, and Google GenAI (Gemini / Vertex AI). It allows you to instantly instantiate premium interactive web interfaces, terminal chat loops, and full-stack chat integrations with zero-config default settings, or fully customize providers and storage backends.

• GitHub Repository: https://github.com/yuichi110/gochat
• API Documentation & Guides: Explore the full documentation, architecture guides, and tutorials on the GitHub Repository.

---

✨ Key Features

• Zero-Config Standalone Mode: Spin up a premium chat web application in two lines of code.
• Unified GenAI Interface: Easily swap between API Key (AI Studio), Vertex AI (Google Cloud Platform), or Mock generation models.
• Interactive UI Partial Renders: Implemented with FastAPI + HTMX for lightning-fast responses without page refreshes.
• Responsive & Premium Aesthetics: Modern responsive design with HSL-curated custom styles.
• Multi-Modal Support: Direct file uploads (images and text documents) natively supported.
• Built-in Terminal Chat Loop: Instantly run interactive AI testing sessions directly from your command-line interface.

---

📦 Installation

GoChat is highly modular and supports optional installation packages (extras) to keep your dependency footprint minimal:

1. Minimal Installation (FastAPI + Presenters Core)

Recommended if you are embedding GoChat and writing custom providers or repositories:

pip install gochat-python

2. Standard Full-Suite Installation

Installs the standard pre-configured package (includes DuckDB database repositories, Mock adapters, Google Gemini SDK, Redis support, and PostgreSQL binary adapters):

pip install gochat-python[standard]

3. Feature-Specific Installations

You can install only the specific components your application uses to keep production environments lean:

• Google Gemini / Vertex AI Support:

  pip install gochat-python[gemini]
  

• DuckDB database + Mock/Test Adapters:

  pip install gochat-python[mock]
  

• PostgreSQL Database Support:

  pip install gochat-python[postgres]
  

• Redis Stream Buffer / Caching Support:

  pip install gochat-python[redis]
  

You can also combine multiple extras together:

pip install gochat-python[gemini,redis]

---

🚀 Quick Start

1. Start the Web UI Application (Zero-Config Standalone)

Start a premium local chat web interface using pre-configured in-memory Mock adapters:

from gochat import GoChat

# Create and launch the application server
app = GoChat()
app.start(host="127.0.0.1", port=8080)

Open your browser to http://127.0.0.1:8080 to interact with your new chat interface.

---

2. Launch a Terminal-Based Chat Loop

Start a live interactive console chat session with a Gemini model using a Google AI Studio API key:

import os
from gochat import GoChat
from gochat.genai_providers import GeminiProvider

# Initialize Gemini GenAI Provider
gemini_provider = GeminiProvider(
    name="gemini",
    description="Gemini via API Key",
    model="gemini-2.5-flash",
    api_key=os.environ["GEMINI_API_KEY"],
    use_vertexai=False,
)

# Launch interactive console loop
GoChat.start_chat(gemini_provider)

---

🛠️ Customization Guide

GoChat follows a clean, multi-layered architecture (Controller, Service, Presenter, GenAI Provider, Repository) with dependency injection. You can inject custom implementations or configurations during instantiation:

Registering Custom AI Providers

You can register multiple AI models or custom wrappers for the user to choose from in the UI dropdown:

from gochat import GoChat
from gochat.genai_providers import GeminiProvider, ImagenProvider

# Define your models
main_provider = GeminiProvider(
    name="gemini-pro",
    model="gemini-2.5-flash",
    api_key="YOUR_API_KEY",
)

image_provider = ImagenProvider(
    name="imagen",
    model="imagen-3.0-generate-002",
    project_id="my-gcp-project-id",
    region="us-central1",
    use_vertexai=True,
)

# Inject providers into GoChat
chat_app = GoChat(
    genai_providers=[main_provider, image_provider],
    title_genai_provider=main_provider,
)

chat_app.start(host="127.0.0.1", port=8080)

Setting Configurations & Feature Flags

Inject customized configurations via typed Pydantic settings:

from gochat import GoChat
from gochat.settings import FeatureSettings, CookieSettings

# Enable/disable application features
features = FeatureSettings(
    signin=True,
    signup=True,
    streaming=True,
    file_upload=True,
)

# Custom cookie configurations
cookies = CookieSettings(
    access_token_cookie_name="my_access_token",
    chat_id_cookie_name="my_chat_id",
)

chat_app = GoChat(
    feature_settings=features,
    cookie_settings=cookies,
)

---

📖 License

Licensed under the Apache License, Version 2.0. See the LICENSE file on GitHub for details.