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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sdg_agents-0.1.0.tar.gz.
File metadata
- Download URL: sdg_agents-0.1.0.tar.gz
- Upload date:
- Size: 21.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
650bb4ef44c23ac895d4ced50c659da89e4011e50c18e5860521037827daf78e
|
|
| MD5 |
2eba801e273b9b2880db5ac86c1b81b3
|
|
| BLAKE2b-256 |
8b85e91e751529f2e2c3f09cb6d13d8b64dd20af01bd0039449262fd08180fce
|
File details
Details for the file sdg_agents-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sdg_agents-0.1.0-py3-none-any.whl
- Upload date:
- Size: 26.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
43370d28f734234495b85cb125e2b7767e219c4ceb1d2da8468d5cb8d48f5834
|
|
| MD5 |
5c90590e14e859316318831b7af61f08
|
|
| BLAKE2b-256 |
ed1b8798ad7dbacaeecfbc244006105a5220d07957888c71dace4738d5447920
|