Metadata-Version: 2.0
Name: gitlab-stats
Version: 1.1.3
Summary: Get gitlab stats
Home-page: UNKNOWN
Author: sylhare
Author-email: sylhare@outlook.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: gitlab pipeline stats build
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'

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``

|General project settings|

How to use
~~~~~~~~~~

When installed you should be able to run it like that:

.. code:: bash

   gitlab_stats <id> -u <your gitlab url> -p <your proxy>

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'

.. |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
.. |General project settings| image:: https://github.com/Sylhare/gitlab_stats/blob/master/docs/screenshot.png?raw=true


