Skip to main content

Web dashboard for monitoring and interacting with the LlamaAI Ecosystem.

Project description

llama-dashboard

PyPI version License Python Version CI Status

Llama Dashboard (llama-dashboard) provides a web-based dashboard application for visualizing data and monitoring systems within the LlamaSearch AI ecosystem. It connects to various data sources to present information graphically.

Key Features

  • Web Application: A dashboard application, likely built with a framework like Flask or Streamlit (app.py).
  • Data Source Connectors: Components to fetch data from different sources (databases, APIs, logs) (data_sources.py).
  • Visualization: Displays data using charts, graphs, and tables.
  • Core Module: Manages application setup and data fetching logic (core.py).
  • Configurable: Allows defining data sources, visualization types, and refresh rates (config.py).

Installation

pip install llama-dashboard
# Or install directly from GitHub for the latest version:
# pip install git+https://github.com/llamasearchai/llama-dashboard.git

Usage

(Instructions on how to run the dashboard application will be added here.)

# Example command to run the dashboard
llama-dashboard run --config dashboard_config.yaml
# Then access via http://localhost:8050 (or similar)

Architecture Overview

graph TD
    A[User (Web Browser)] --> B{Dashboard Web App (app.py)};
    B -- Requests Data --> C{Core Module (core.py)};
    C --> D{Data Source Interface (data_sources.py)};
    D -- Fetches Data --> E[(Data Source 1: DB)];
    D -- Fetches Data --> F[(Data Source 2: API)];
    D -- Fetches Data --> G[(Data Source 3: Logs)];
    E --> D;
    F --> D;
    G --> D;
    D --> C;
    C -- Formats Data --> B;
    B -- Renders UI / Visualizations --> A;

    H[Configuration (config.py)] -- Configures --> C;
    H -- Configures --> D;

    style B fill:#f9f,stroke:#333,stroke-width:2px
    style E fill:#ccf,stroke:#333,stroke-width:1px
    style F fill:#ccf,stroke:#333,stroke-width:1px
    style G fill:#ccf,stroke:#333,stroke-width:1px
  1. User Interface: The user accesses the dashboard through a web browser.
  2. Web Application: Handles user requests and renders the dashboard UI.
  3. Core Module: Orchestrates data fetching based on the dashboard configuration.
  4. Data Source Interface: Connects to and retrieves data from various configured backends.
  5. Data Formatting: Data is processed and formatted for visualization.
  6. Rendering: The web application displays the data using charts and other UI elements.
  7. Configuration: Defines data sources, connection details, visualization types, refresh intervals, etc.

Configuration

(Details on configuring data source connections (DB URIs, API endpoints/keys), dashboard layouts, chart types, etc., will be added here.)

Development

Setup

# Clone the repository
git clone https://github.com/llamasearchai/llama-dashboard.git
cd llama-dashboard

# Install in editable mode with development dependencies
pip install -e ".[dev]"

Testing

pytest tests/

Contributing

Contributions are welcome! Please refer to CONTRIBUTING.md and submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

llama_dashboard-0.1.0.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

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

llama_dashboard-0.1.0-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file llama_dashboard-0.1.0.tar.gz.

File metadata

  • Download URL: llama_dashboard-0.1.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for llama_dashboard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 86044a801e341619e2f9773f96da580dca326e2085a62134222865479f29d005
MD5 0791a83e2586b96f017a493a53c8e055
BLAKE2b-256 5d95a6f4d40b88832a1d76794aef492534193a1b774d9b8f09c69331f94ab564

See more details on using hashes here.

File details

Details for the file llama_dashboard-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for llama_dashboard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f19b9025f98423cd38496cb7fafae5d861b6652de86dc9a73f38b840d8bca01
MD5 9041cdabdd1db43e24461c8d9d5cdd30
BLAKE2b-256 84fc63cb8bbde288d51a247959ca28718f77eab8eb636420f1b42d4d3714c334

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