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 through a minimal, Python-based stack.

Design

The system is built on a minimalist "bare-metal" architecture, utilizing FastAPI and SQLite to ensure zero-configuration deployment on lightweight Linux VMs without the overhead of external databases. Configuration happens via an optional darkglass.toml file placed in the working directory; supported TOML keys are gemini_api_key and prompt. For example:

gemini_api_key = "mysecretkey"
prompt = "You are a helpful agent for Acme College."

The TOML parser uses Python’s built‑in tomllib, so Python 3.11 or newer is required. To guarantee long-term stability and eliminate dependency churn, the application avoids high-level LLM frameworks in favor of direct REST calls via Python's standard urllib library. The default integration targets Google's Gemini API using the configured API key. Institutional knowledge is managed through a system prompt, either embedded or supplied via TOML, removing the complexity of vector databases and custom search tools. This approach culminates in a cohesive application that serves a lightweight JavaScript widget to prospective students and a secure Google Auth-protected interface for administrators, maintaining a strict, minimal dependency footprint.

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-0.4.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

darkglass-0.4.0-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: darkglass-0.4.0.tar.gz
  • Upload date:
  • Size: 8.4 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-0.4.0.tar.gz
Algorithm Hash digest
SHA256 10cee68721377042c7beccf185cd2b0b2caab82ee91f6d8781aba99761bc700e
MD5 b9f9877c2d8ce481a4a337c64ea2d34f
BLAKE2b-256 bebdc29eb3702fa0d0b71c3663b0ae80d38a6bc499af92a141f1eec9968d455c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: darkglass-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.9 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-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 254c4b2297e750a3715aa6884246b18072a6becfe1e32e9e02a8cb6c61c84b6a
MD5 9221fb1c2ab1fe7692737ece2e151390
BLAKE2b-256 1caa33595366b9191635bb159b4611afa6b8760f8bb94ab29e94929f45c438ce

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