Skip to content

Vojtech1025/gitlab-monitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitLab Monitor 🚀

A Windows system tray application that monitors GitLab repositories for releases, merge requests, and other activities.

Features ✨

  • 🔔 Real-time Notifications: Get notified about new GitLab releases
  • 🖥️ System Tray Integration: Runs quietly in your system tray with easy access
  • 📊 Release Monitoring: Track new releases across multiple GitLab repositories
  • 🎨 Dynamic Icons: Custom-generated icons based on activity status
  • ⚙️ Configurable: Easy configuration through environment variables

Prerequisites 📋

  • Windows 10/11
  • Python 3.8+
  • GitLab account with API access
  • uv package manager

Setup 🛠️

1. Install uv package manager

Follow the official instructions to install uv from the Astral documentation:
https://docs.astral.sh/uv/getting-started/installation/

2. Install Dependencies

# Clone repository and install dependencies
git clone <your-repository-url>
cd gitlab-monitor
uv sync

3. Configure Environment

Copy the sample environment file and customize it:

cp .env_sample .env

Edit .env file with your configuration:

# GitLab API Configuration
GITLAB_API_TOKEN=your_gitlab_personal_access_token_here

# GitLab Base URL (customize for your GitLab instance)
GITLAB_BASE_URL=https://your-gitlab-instance.com

# GitLab Projects to Monitor (comma-separated list)
# Format: namespace/project, namespace/project, ...
GITLAB_PROJECTS=namespace1/project1,namespace1/project2,namespace2/project3

Configuration Details:

  1. Get your GitLab token:

    • Go to GitLab → User Settings → Access Tokens
    • Create token with scopes: api, read_user, read_repository
    • Copy token to GITLAB_API_TOKEN
  2. Set your GitLab URL:

    • Replace https://your-gitlab-instance.com with your actual GitLab server URL
    • For GitLab.com use: https://gitlab.com
  3. Configure projects to monitor:

    • Replace the example projects with your actual project paths
    • Use format: namespace/project-name
    • Separate multiple projects with commas

4. Run Application

uv run gitlab_monitor.py

5. Build Executable (Optional)

To create a standalone .exe file:

# Install PyInstaller
uv add pyinstaller

# Build executable
uv run pyinstaller --onefile --windowed --name gitlab_monitor gitlab_monitor.py

# The .exe file will be in the dist/ folder

The executable will be located at dist/gitlab_monitor.exe and can be run without Python installed.

Windows Startup 🚀

To start with Windows boot:

  1. Press Win + R and type shell:startup
  2. Create a shortcut to your gitlab_monitor.exe file in the startup folder
  3. Right-click shortcut → Properties → Set "Start in" to your project directory

Happy Monitoring! 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages