# ![GitHub Pulse Logo](src/app_components/assets/pulse_logo_white_no_bkg_github.png)

A Python-based GUI application for GitHub automation workflows and AI assisted workflows.

> [!NOTE]
> This project is currently in active development. Features and functionality may change frequently. Bug reports and contributions are welcome and encouraged!
> Please be aware that some features may be incomplete or unstable.

![GitHub Pulse img](src/app_components/assets/github_pulse_img.png)

## Pulse Workflow

![Pulse Workflow img](src/app_components/assets/flow-diagram.png)

## Project Structure

```text
github_pulse/
├── src/             # Main application directory
│   ├── main.py               # Application entry point
│   ├── requirements.txt     # Python dependencies
│   ├── assets/               # Images for build
│   │   ├── icon.png         # Application icon
│   │   └── splash_android.png # Splash screen image
│   ├── requirements/  
│   │   ├── requirements-dev.txt  # Development dependencies
│   │   ├── requirements-ai.txt  # AI dependencies
│   │   ├── requirements.txt  # Production dependencies
│   │   └── requirements-base.txt  # Base dependencies
│   └── app_components/      # Application modules
│       ├── assets/          # Images and assets
│       │   ├── flow-diagram.png              # Workflow diagram              
│       │   ├── github_pulse_img.png          # GitHub Pulse image
│       │   ├── pulse_logo_gray_no_bkg.png  # GitHub Pulse logo
│       │   ├── pulse_logo_white_no_bkg_github.png          # Pulse logo
│       │   ├── pulse_logo_white_no_bkg.png               # Pulse logo with background
│       │   └── pulse_logo_white_w_black_bkg.png      # GitHub Pulse logo with background
│       ├── __init__.py          # Package initializer
│       ├── ai_manager.py           # AI provider integration
│       ├── cache_manager.py        # Caching functionality
│       ├── config_manager.py       # Configuration management
│       ├── github_api.py           # GitHub API client
│       ├── main_gui.py             # Main GUI interface
│       ├── processing_log_dialog.py  # Processing log dialog
│       ├── settings_dialog.py      # Settings dialog
│       ├── settings_manager.py     # Settings management
│       ├── utils.py                # Utility functions
│       └── workflow.py             # Workflow processing
├── assets/                   # Images and assets
├── README.md               # Readme file
├── SETUP.md                # This file
└── LICENSE                 # License information
```

## Prerequisites

- Python 3.8 or higher
- Git installed and configured
- GitHub account with repository access

## Quick Start

1. **Clone the repository**

   ```bash
   git clone https://github.com/TySP-Dev/github_pulse.git
   cd github_pulse/src
   ```

2. **Create and activate virtual environment**

   ```bash
   # Create virtual environment
   python -m venv venv

   # Activate (Windows)
   venv\Scripts\activate

   # Activate (macOS/Linux)
   source venv/bin/activate
   ```

3. **Install dependencies**

   ```bash
   # For all production dependencies
   pip install -r requirements/requirements.txt
   ```

   ```bash
   # For dev dependencies
   pip install -r requirements/requirements-dev.txt
   ```

   ```bash
   # For ai dependencies
   pip install -r requirements/requirements-ai.txt
   ```

   ```bash
   # For base dependencies
   pip install -r requirements/requirements-base.txt
   ```

4. **Run the application**

   ```bash
   python app.py
   ```

## Configuration

Configuration is managed through a `.env` file or settings dialog in the application.

See [SETUP.md](SETUP.md) for detailed setup instructions.

## Contributing

This project welcomes contributions and suggestions. In order to contribute, please fork the repository and create a pull request.

## License

GNU General Public License v3.0.
See [LICENSE](LICENSE) file for details.