Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sgaunet/gitlab-stats

tool to register stats of gitlab projects/groups and make a barchart of activity
https://github.com/sgaunet/gitlab-stats

gitlab statistics

Last synced: 4 months ago
JSON representation

tool to register stats of gitlab projects/groups and make a barchart of activity

Host: GitHub
URL: https://github.com/sgaunet/gitlab-stats
Owner: sgaunet
License: mit
Created: 2022-12-11T20:54:50.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-10-01T19:50:41.000Z (5 months ago)
Last Synced: 2024-10-21T18:18:08.452Z (4 months ago)
Topics: gitlab, statistics
Language: Go
Homepage:
Size: 190 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/sgaunet/gitlab-stats)](https://goreportcard.com/report/github.com/sgaunet/gitlab-stats)

[![GitHub release](https://img.shields.io/github/release/sgaunet/gitlab-stats.svg)](https://github.com/sgaunet/gitlab-stats/releases/latest)

![GitHub Downloads](https://img.shields.io/github/downloads/sgaunet/gitlab-stats/total)

[![Maintainability](https://api.codeclimate.com/v1/badges/0bfeceb0b75d338d116d/maintainability)](https://codeclimate.com/github/sgaunet/gitlab-stats/maintainability)

[![License](https://img.shields.io/github/license/sgaunet/gitlab-stats.svg)](LICENSE)

# gitlab-stats

gitlab-stats is a tool to register stats of gitlab projects/groups. Based on the statistics saved, it can generate a graph to visualize the activity on gitlab projects/groups.

Example:

![screenshot](doc/screenshot.png)

Actually, the stats are saved in $HOME/.gitlab-stats/db.json.

To register stats, you need to add cron, for example: 

```

00 00 * * * GITLAB_TOKEN=.... /usr/local/bin/gitlab-stats -g    # comment

```

To generate the screenshot, you can also add a cron or execute it in the command line. Example of a cron:

```

00 00 1 * * /usr/local/bin/gitlab-stats -g  -o stats-`date "+%Y-%m" -d "1 day ago"`.png

```

# Usage

```

$ gitlab-stats -h

Usage of gitlab-stats:

  -d string

        Debug level (info,warn,debug) (default "error")

  -g int

        Group ID to get issues from (not compatible with -p option)

  -o string

        file path to generate statistic graph (do not fullfill DB)

  -p int

        Project ID to get issues from

  -s int

        since (default 6)

  -v    Get version

```

# Development

## prerequisites

This project is using :

* golang

* [task for development](https://taskfile.dev/#/)

* [goreleaser](https://goreleaser.com/)

* [pre-commit](https://pre-commit.com/)

There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:

```

brew install pre-commit

```

Install tools:

```

task install-prereq

```

And install the hooks:

```

task install-pre-commit

```

If you like to launch manually the pre-commmit hook:

```

task pre-commit

```

sudo apt install sqlite3 sqlite3-tools