keneandita/gitlogcli repository overview

⁠Project Summary

This repository provides a containerized version of Gitlog-cli, a lightweight terminal-based application that displays a user's GitHub activity directly in the command line. The tool retrieves recent activity such as commits, pull requests, and issues and presents the information in a structured and readable format.

Gitlog-cli is designed for developers who prefer to monitor their GitHub activity without leaving the terminal environment. By integrating with the GitHub API and formatting output using terminal styling libraries, the application delivers a clear overview of user activity in a compact interface.

The Docker image allows the application to run in an isolated environment without requiring local Python setup or manual dependency installation.

⁠Architecture Overview

The application is implemented as a Python-based command-line interface that communicates with the GitHub API to retrieve activity data.

The CLI interface allows users to specify a GitHub username and request activity data directly from the terminal. The application processes the request and retrieves recent public activity from GitHub.

The GitHub API integration layer handles communication with the GitHub API and parses the returned event data. This includes activities such as commits, pull requests, and issue interactions.

The terminal rendering layer formats the retrieved data using the Rich library, producing structured and visually organized output that improves readability within the terminal.

The Docker container environment packages the Python runtime, application code, and dependencies into a single image, ensuring consistent execution across different systems without requiring local installation.

⁠Key Features

GitHub Activity Tracking

The application retrieves and displays recent GitHub activity for a specified user, including commits, pull requests, and issue interactions.

Terminal-Based Interface

Gitlog-cli runs entirely within the terminal, making it suitable for developers who prefer command-line workflows.

Formatted Terminal Output

Activity data is displayed using structured formatting provided by the Rich library, improving readability and organization in the terminal.

Lightweight and Fast

The application is designed to run quickly with minimal system requirements while providing concise summaries of GitHub activity.

Cross-Platform Compatibility

The CLI tool can run on multiple operating systems through Python or through its containerized environment.

Containerized Execution

The Docker container encapsulates the runtime environment and dependencies, allowing the application to run without local configuration.

⁠How to Run

First, pull the container image.

docker pull keneandita/gitlogcli

After the image is downloaded, run the container and specify the GitHub username whose activity you want to view.

docker run -it keneandita/gitlogcli --username <github-username>

The container will execute the CLI tool and display the user’s recent GitHub activity directly in the terminal.