Skip to main content

A terminal user interface (TUI) for SDG Agents

Project description

SDG Agents TUI

A comprehensive Terminal User Interface (TUI) for SDG Agents (Sustainable Development Goals Agents). Built using Textual and Rich, this tool provides a powerful, keyboard-driven interface to manage tasks, interact with AI agents, and monitor sustainability projects directly from your terminal.


Features

  • 🏠 Home Dashboard: A unified overview of SDG-related metrics, ongoing tasks, and recent agent activities.
  • 💬 AI Chat: Direct conversational interface with specialized SDG agents to brainstorm solutions, analyze data, and generate reports.
  • 📋 Task Management: A fully functional board to organize, assign, and track progress on sustainable development tasks.
  • ** sidebar Navigation Sidebar**: A collapsible sidebar panel for seamless transitions between different views.
  • ❓ Help Screen: An on-screen reference containing all keybindings, tips, and documentation.
  • 🌙 Dark Theme: Built-in support for dark mode/themes to keep your terminal easy on the eyes.

Installation

To install the package in editable mode (development), clone or navigate to the directory and run:

pip install -e .

This will install the package alongside its dependencies: textual, rich, and click.


Usage

Once installed, you can launch the TUI by running:

sdg-agents

CLI Options

You can display the help information or check the version using the standard CLI options:

  • Show Help:
    sdg-agents --help
    
  • Show Version:
    sdg-agents --version
    

Keybindings

Navigate and control the entire application using keyboard shortcuts.

Keybinding Action
Ctrl+Q Quit the application
Ctrl+H Switch to the Home Dashboard
Ctrl+C Switch to the AI Chat view
Ctrl+T Switch to the Task Management view
Ctrl+P Switch to the Help Screen
Ctrl+S Toggle the Navigation Sidebar visibility
Tab Move focus to the next element / widget
Shift+Tab Move focus to the previous element / widget

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

sdg_agents-0.1.2.tar.gz (23.3 kB view details)

Uploaded Source

Built Distribution

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

sdg_agents-0.1.2-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file sdg_agents-0.1.2.tar.gz.

File metadata

  • Download URL: sdg_agents-0.1.2.tar.gz
  • Upload date:
  • Size: 23.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for sdg_agents-0.1.2.tar.gz
Algorithm Hash digest
SHA256 cdd8418a34e415d7303779c2ce5a770280a1ca68ff6d1da8fb0fbf88910cb9d7
MD5 f10424c29726a4103cc0fd1d4c062c03
BLAKE2b-256 bc8bfabd87f5b750407ee6e8df63d63eeffa98758df29b7c0762bda8d6d9c498

See more details on using hashes here.

File details

Details for the file sdg_agents-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: sdg_agents-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for sdg_agents-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3161376e367b337c1d2c7723cd79416e0766f539bbf38c9a9dc65f2784646b66
MD5 44321b9230311772d5dea182a52b68f8
BLAKE2b-256 4898ecdd51c1f5845c15f84104c123089e660d5d5281b410564ef2b9ac1b9390

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