Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sylhare/gitlab_stats
Get to the gitlab API and generates a report based on the pipeline builds.
https://github.com/sylhare/gitlab_stats
Last synced: 3 months ago
JSON representation
Get to the gitlab API and generates a report based on the pipeline builds.
- Host: GitHub
- URL: https://github.com/sylhare/gitlab_stats
- Owner: sylhare
- License: mit
- Created: 2018-06-22T13:19:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-23T15:46:32.000Z (over 3 years ago)
- Last Synced: 2024-09-13T23:56:45.797Z (4 months ago)
- Language: Python
- Homepage:
- Size: 583 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Gitlab-stats
------------
|Github| |PyPI version| |Gitlab| |Python| |Build Status| |codecov|
|Codacy Badge|
Get to the gitlab API and generates a report based on the pipeline
builds. Creates a report for the pipelines of the last two weeks. (On
the assumption that there are less than 100 push per 2 weeks)
Installation
~~~~~~~~~~~~
Install via pip using:
.. code:: bash
pip install gitlab_stats
Local install with pip3:
.. code:: bash
pip3 install -e .
In order to make it work:
- Create a ``GITLAB_TOKEN`` env variable with your access token.
Get the project ID
~~~~~~~~~~~~~~~~~~
For the script to work, you will need to get the project ID of your
gitlab project. It is a unique ID that is used by the gitlab REST API to
store your project information.
Get it in
``[your project] > Settings > General > General project settings``
.. figure:: https://github.com/Sylhare/gitlab_stats/blob/master/docs/screenshot.png?raw=true
:alt: General project settings
General project settings
How to use
~~~~~~~~~~
When installed you should be able to run it like that:
.. code:: bash
gitlab_stats -u -p
Here is the help when ``gitlab_stats -h``:
.. code:: bash
usage: gitlab_stats [-h] [-r] [-u URL] [-p PROXY] id
gitlab_stats: Generate a report from gitlab's pipeline metrics
positional arguments:
id Put the id of the gitlab project
optional arguments:
-h, --help show this help message and exit
-r, --report Generate a csv report
-u URL, --url URL Put the url of your gitlab instance if different from
https://gitlab.com
-p PROXY, --proxy PROXY Add the url of your proxy like
'http://my.proxy.url:8083'
You can save proxy with ``HTTP_PROXY`` or gitlab url with
``GITLAB_URL``.
Docker
~~~~~~
To build the docker use:
.. code:: bash
docker build -t gitlab_stats . --build-arg token="your token" --build-arg proxy="your proxy" --build-arg gitlab="gitlab url"
To run the docker use:
.. code:: bash
# Having set the token, the proxy and the url when building it:
docker run -it exec gitlab_stats bash gitlab_stats project_id
Important Note:
~~~~~~~~~~~~~~~
You will need an access token set up as an environment variable to reach
your gitlab.
To get an access token based on your personal credentials go to your
gitlab server ``[Account] -> [Settings] -> [Access Tokens]``
.. figure:: https://github.com/Sylhare/gitlab_stats/blob/master/docs/token.png?raw=true
:alt: General project settings
General project settings
Then give it a name and click ``Create personal access token``.
Save this token somewhere safe then in bash:
.. code:: bash
export GITLAB_TOKEN=
.. |Github| image:: https://img.shields.io/badge/github-gitlab_stats-blue.svg
:target: https://github.com/Sylhare/gitlab_stats
.. |PyPI version| image:: https://badge.fury.io/py/gitlab-stats.svg
:target: https://pypi.org/project/gitlab-stats/
.. |Gitlab| image:: https://img.shields.io/badge/gitlab_api-v4-orange.svg
:target: https://github.com/Sylhare/gitlab_stats
.. |Python| image:: https://img.shields.io/badge/python-3.6.x-yellow.svg
:target: https://github.com/Sylhare/gitlab_stats
.. |Build Status| image:: https://travis-ci.org/Sylhare/gitlab_stats.svg?branch=master
:target: https://travis-ci.org/Sylhare/gitlab_stats
.. |codecov| image:: https://codecov.io/gh/Sylhare/gitlab_stats/branch/master/graph/badge.svg
:target: https://codecov.io/gh/Sylhare/gitlab_stats
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/d31f29a89e4f4c929b945d931ba1db26
:target: https://www.codacy.com/app/Sylhare/gitlab_stats?utm_source=github.com&utm_medium=referral&utm_content=Sylhare/gitlab_stats&utm_campaign=Badge_Grade