gitlab-utils 0.1.1

A Python SDK for interacting with code.swecha.org using GitLab API v4.

gitlab-utils

A Python-based toolkit to interact with GitLab APIs on Swecha's self-hosted GitLab instance code.swecha.org. gitlab-utils streamlines GitLab workflows by offering tools to track and summarize contributions, Automate merge request pipelines, Generate issue reports and activity logs and Ensure development standards and reproducibility across projects.

🚀 Features

• Onboarding users to specific groups
• Generates commit summaries and member-wise contribution stats
• Generates Daily reports based on the Issues created and contributions done
• Get specific information of a individual user

🛠️ Installation Setup

Using pip

pip install gitlab-utils

Using uv

uv pip install gitlab-utils

🚀 Initial Client Setup

To start using the SDK, initialize the GitLabClient with your GitLab instance URL and a valid private token:

from gitlab_utils.client import GitLabClient

client = GitLabClient(
    base_url="gitlab_instance_url",
    private_token="your_gitlab_token/admin_token"
)

Example: base_url="https://code.swecha.org"

📁 Project Structure

gitlab-utils/
├── .gitlab/
│   ├── templates/
│   │    ├──MR_template.md
│   │    └──issue_template.md
│   └── workflow/
│        └── lint.yml
├── gitlab_utils/
│   ├── __init__.py
│   ├── client.py                 # Main logic
│   └── apis/                     # Modular API handlers
│        ├── __init__.py
│        └── users.py
├── tests/                        # Unit tests for client
│   ├── __init__.py
│   ├── confest.py
│   ├── test_client.py
│   └── test_users.py
│
├── .env.example
├── .gitignore
├── .gitlab-ci.yml                # GitLab CI pipeline config
├── .pre-comit-config.yaml
├── LICENSE                       # GNU GPL v3 License
├── CHANGELOG.md
├── README.md                     # Project overview and usage
├── CONTRIBUTING.md               # Contribution guidelines
├── CODE_OF_CONDUCT.md            # Community standards
├── pyproject.toml                # Project configuration
└── uv.lock

💬 Support

Need help or have a question about gitlab-utils?
E-Mail the maintainers at [e-mail]

• 🐛 Found a bug?
  If you encounter any bugs in the codebase, please create an issue with label bug

• 💡 Have a feature request or idea?
  Feel free to create a new issue labeled feature-request availabe in tags.

Make sure to follow the provided ISSUE BOARD TEMPLATE

Contributing to gitlab-utils

🎉 Thank you for considering contributing to gitlab-utils

We welcome all kinds of contributions: code, documentation, bug reports, feature requests, ideas, and feedback, refer this DOCUMENTATION.

Realtime Applications of gitlab-utils

Several applications have integrated Gitlab-utils into their codebase.

• SoAI - Dashboard
• BITS - Dashboard
• ICFAI - Dashboard

📝 License

This project is licensed under the GNU General Public License v3.0.

You are free to use, modify, and distribute this software for any purpose, provided that:

The original license and copyright notice are included. Any derivative work must also be distributed under the same license. See the LICENSE