Metadata-Version: 2.4
Name: sdg-agents
Version: 0.1.2
Summary: A terminal user interface (TUI) for SDG Agents
Author: sdg-agents contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/sdg-agents/sdg-agents
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual>=0.47.0
Requires-Dist: rich>=13.0.0
Requires-Dist: click>=8.0.0
Dynamic: license-file

# SDG Agents TUI

A comprehensive Terminal User Interface (TUI) for **SDG Agents** (Sustainable Development Goals Agents). Built using [Textual](https://github.com/Textualize/textual) and [Rich](https://github.com/Textualize/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:

```bash
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:

```bash
sdg-agents
```

### CLI Options

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

- **Show Help**:
  ```bash
  sdg-agents --help
  ```
- **Show Version**:
  ```bash
  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](LICENSE) file for details.
