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.1.0.tar.gz (743.8 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.1.0-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: darkglass-1.1.0.tar.gz
  • Upload date:
  • Size: 743.8 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.1.0.tar.gz
Algorithm Hash digest
SHA256 84617c289dc178e60d6b72103f31177a04faa96bab57ecef0527f67a8d424e0d
MD5 22ed5201a5715a8c22ab7630f1c4bf89
BLAKE2b-256 b55f5b6a4489271edb99f75ddd51d7f5d5a67039ce49476328e2845793ca2aca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: darkglass-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.0 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.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9fe010006cc20acf727b8a72aa60238f4a2b22d0b49aeadb26d8786bf10f8204
MD5 ca312b1ca0e54a1d2e379e6fe1210370
BLAKE2b-256 1a1aec2cfd6aaa8b23495840e6c2ee9f64176c88727de2cf701fa1fa05323a60

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