Skip to main content

A GitLab bot that tidies and attends to repositories

Project description

GitLab Attendant

Build Status Code style: black License: MIT

Description

The GitLab Attendant is a bot that will tidy and attend to repositories on a specified GitLab installation at a scheduled basis. Currently the bot is capable of removing merged branches, assigning project members to open issues, assigning project members to open merge requests, notifying issue assignees of due or overdue issues, and notifying assignees of stale merge requests.

In order to use the GitLab Attendant fully, you should create a new account within the specified GitLab installation with privileges that will allow the bot to read and write any changes necessary to branches, merge requests, issues, etc. The personal access token for this account should then be entered in the token paramter when calling the bot from the command line.

Python 3.6 or Python 3.7 are required to run this utility.

Installation

This utility can be installed through pip by running the following command:

pip install gitlab-attendant

Usage

gitlab-attendant --ip localhost --interval 7 --token TOKEN

Options:
  --ip          The IP address of the GitLab installation.
  --interval    task scheduler interval in hours (ex. 1, 10) [default: 24]
  --token       GitLab personal access token.

This will run the GitLab Attendant process, which will begin attending to the specified GitLab installation at the first interval specified.

Tests

Tests for this project utilise the Pytest framework. To run the existing suite of unit tests run the following command within the root directory:

pytest

Notes

All Python code has been formatted by Black, 'the uncompromising Python code formatter'.

Type checking has been provided by Pyre.

Continuous integration is handled by Travis CI.

License

See LICENSE.md.

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

gitlab-attendant-0.0.1.tar.gz (2.4 kB view details)

Uploaded Source

Built Distribution

gitlab_attendant-0.0.1-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file gitlab-attendant-0.0.1.tar.gz.

File metadata

  • Download URL: gitlab-attendant-0.0.1.tar.gz
  • Upload date:
  • Size: 2.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for gitlab-attendant-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c78db6b1d06678d8db69c6482a09b9fc716087de9646f938f51f814f24efead6
MD5 4a7be6b841927b1772adc2f181b34d5f
BLAKE2b-256 154c0beb41eac3730cc56e11a9809691353f06f5dd3d22a01d51949d5ff8a256

See more details on using hashes here.

File details

Details for the file gitlab_attendant-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: gitlab_attendant-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for gitlab_attendant-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d30d4be169d9487be0b5dd9509ce832770fb75cb635c4168a105694d2df035c
MD5 0724221ff2efa929116a72db59b90729
BLAKE2b-256 77711f351d1de1a4bbcd54005c40047172a9328130bb44b53d67d60052aff78b

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