Skip to main content

Structured AI system with emebeddable chatbot

Project description

Darkglass

Lint Test Release PyPI

Darkglass is a lightweight, embeddable chatbot designed for small colleges, providing prospective students with automated responses while logging interactions for administrative review.

Demo

Demo Video

Design

The system is built on a minimalist architecture, utilizing FastAPI and SQLite to provide zero-configuration deployment on lightweight Linux VMs without the overhead of external databases.

Configuration

Add a [gemini] section with your API key and optional model (defaults to gemini-3.1-flash-lite-preview):

[gemini]
api_key = "mysecretkey"
model = "gemini-3.1-flash-lite-preview"

You can also include a [context] section to provide a default prompt for the agent:

[context]
prompt = "You are a helpful agent for Acme College."

To enable a secure administrative dashboard, add a [google] section with a client_id to use for authentication.

[google]
client_id = "your-google-client-id.apps.googleusercontent.com"

To restrict dashboard access to specific addresses, add a [roles] section with an admins list. When admins is non-empty, only addresses listed will be allowed access.

[roles]
admins = ["alice@example.com", "bob@example.com"]

Usage

  1. Set API keys, system prompt, and authorized users in darkglass.toml
  2. Run uvx darkglass or pipx darkglass to launch production server
  3. Use the demo page to test the config: http://localhost:8000/static/index.html
  4. Update reverse proxy configs as required to route requests to darkglass.
  5. Add the following snippet to your site, replacing the URL based on your chosen production endpoint:
<script src="https://darkglass.example.com/static/webchat.js"></script>

Add to arbitrary site via dev tools

let darkglass = document.createElement('script')
darkglass.src = 'http://localhost:8000/static/webchat.js'
darkglass.defer = true
document.body.appendChild(darkglass)

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

darkglass-1.2.1.tar.gz (744.0 kB view details)

Uploaded Source

Built Distribution

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

darkglass-1.2.1-py2.py3-none-any.whl (11.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file darkglass-1.2.1.tar.gz.

File metadata

  • Download URL: darkglass-1.2.1.tar.gz
  • Upload date:
  • Size: 744.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for darkglass-1.2.1.tar.gz
Algorithm Hash digest
SHA256 1707851442a03d493a68aa277f2074cc97b065e68d8db44530d5af209618049a
MD5 1914cf4040aec2d18c4dd62768bd50f4
BLAKE2b-256 007a5d91a8e3b280b246bb077bb43895aedf3d8c99bc3b6afadcc24b539d37db

See more details on using hashes here.

File details

Details for the file darkglass-1.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: darkglass-1.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for darkglass-1.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7a9d9becf2951ee7c52b7ddb1b8afaed3895ddf62fb961dd267858944ef48336
MD5 9cd0716c88d89e654a948b4699c70ae3
BLAKE2b-256 0b190afff72ed4d4d34b5def9d72a04a67935de1ea90819c8b9f5229fce48f8d

See more details on using hashes here.

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