GitLab_Usage_Indicator is a tool designed to retrieve and analyze data from GitLab, such as commits, projects, groups, and more. It generates JSON files containing detailed statistics for use in a graphical interface.
- Python: Version 3.10 or higher
- Dependencies: See the
requirements.txtfile
-
Make sure Python is installed on your machine:
python --version
-
Clone the GitLab repository:
git clone https://github.com/AntoineB0/GitLab_Usage_Indicator.git cd GitLab_Usage_Indicator -
Install the required dependencies:
pip install -r requirements.txt
-
Add the GitLab environment variables:
Go to: Settings > CI/CD > Variables
CI_MAIL: Email address of the account used to perform commitsCI_NAME: Name of the account used to perform commitsCI_PUSH_TOKEN: Personal access token of the account used to perform commitsCI_PROJECT_PATH: The project path on the GitLab instancePRIVATE_KEY: Private key with administrator read access to the GitLab instance
-
Set up daily continuous integration
Go to: Build > Pipeline schedules
- Create a new schedule
- Set your time zone
- In the
Interval Pattern, define the time of day to trigger the update - Create the pipeline
-
GitLab Data Collection:
- Users (Accounts)
- Projects (Repositories)
- Forks
- Issues
- Groups
- Commits
- Languages
- Public vs Private distribution
- Number of SSH keys
- Number of Gitlab pages activated
-
JSON File Generation:
- Daily commit data
- Cumulative commit data
-
CI/CD Pipeline:
- Automation of JSON file generation and deployment
This project is licensed under the GNU GPL v3. See the LICENSE.md file for more details.
- Antoine BERTELOOT: Intern Developer (antoine.berteloot@etu.unilim.fr)
- XLIM, University of Limoges: Hosting institution
- Status: Actively in development