Skip to main content

An async GitLab API library

Project description

https://img.shields.io/badge/code%20style-black-000000.svg pre-commit Documentation Status https://gitlab.com/beenje/gidgetlab/badges/master/pipeline.svg https://gitlab.com/beenje/gidgetlab/badges/master/coverage.svg

An asynchronous GitLab API library.

This library is based on gidgethub from Brett Cannon, an async GitHub API library.

I liked the concept with the asynchronous and sans-I/O approach and decided to adapt it to the GitLab’s API. All credit to Brett Cannon for the initial library!

Quick start

Here is a complete example of a server that responds to webhooks which will greet the author and say thanks whenever an issue is opened:

from gidgetlab.aiohttp import GitLabBot

bot = GitLabBot("beenje")


@bot.router.register("Issue Hook", action="open")
async def issue_opened_event(event, gl, *args, **kwargs):
    """Whenever an issue is opened, greet the author and say thanks."""
    url = f"/projects/{event.project_id}/issues/{event.object_attributes['iid']}/notes"
    message = f"Thanks for the report @{event.data['user']['username']}! I will look into it ASAP! (I'm a bot)."
    await gl.post(url, data={"body": message})


if __name__ == "__main__":
    bot.run()

Installation

Gidgetlab is available on PyPI.

python3 -m pip install gidgetlab

To install web server support (e.g. for aiohttp or tornado), specify it as an extra dependency:

python3 -m pip install gidgetlab[aiohttp]

Note that the library is still in alpha development stage.

Goals

The key goal is the same as gidgethub (but for GitLab): to provide an async base library for the GitLab API which performs no I/O of its own (a sans-I/O library).

Another goal is to easily write GitLab bots: applications that run automation on GitLab, using GitLab WebHooks and API. This was inspired by Mariatta PyCon 2018 workshop: Build-a-GitHub-Bot Workshop.

Alternative libraries

If you think you want a different approach to the GitLab API, GitLab maintains a list of libraries.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gidgetlab-2.1.0.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

gidgetlab-2.1.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file gidgetlab-2.1.0.tar.gz.

File metadata

  • Download URL: gidgetlab-2.1.0.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for gidgetlab-2.1.0.tar.gz
Algorithm Hash digest
SHA256 60c39516261b788e7643ae12fae106a79329450d908e821c9a591ab6c52ffe95
MD5 97b03d045c8c81db4ab4e0b87583c536
BLAKE2b-256 3df264c9091f79e3ecd344d892eb733d585c70ffb788a7277c3f257bc9d09375

See more details on using hashes here.

File details

Details for the file gidgetlab-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: gidgetlab-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for gidgetlab-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa0512dc9565b2c1bdb2521261c17b7cb721f9a7f7cc1a6289039ebd77847df1
MD5 da2af72839af5333c594913ea1cfcf1c
BLAKE2b-256 dc32d068dbb649fcd3cc4e28e9f099533780122ed1575affd60387f4b40bfcae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page