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.1.tar.gz (21.4 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.1-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sdg_agents-0.1.1.tar.gz
  • Upload date:
  • Size: 21.4 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.1.tar.gz
Algorithm Hash digest
SHA256 6cccfc9095104938c5d7dbd32c04ae7b7989fb981ec7dcc21cd34b6b471615bd
MD5 af84e168a627c898580023247dbb03cb
BLAKE2b-256 4652b42badc7617db58ecf770ebce530bc01662b273f5b059ba60b9f1e109afd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sdg_agents-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 26.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 608c31dfa5c4f612a583bf44d8f500b7249028de7c7358bb6af674865aa2c64e
MD5 a987774303d86a4e9e25b3f6a7013018
BLAKE2b-256 a27049e76fb0d981596e327d85e8c4963f510f5922786376259b31b40f943410

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