feat: year review for GitHub and GitLab (#181) (#186)

Add scripts in Python to request GitHub and GitLab API to compute some figures and metrics for a given year.

Assisted-by: GPT-4o-mini (Dinootoo)
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

Author: pylapp

.gitignore

@@ -1,13 +1,19 @@
 toolbox/github/data
+toolbox/github/.env
+
 toolbox/diver/data
 toolbox/diver/.floss-toolbox/data
+
 toolbox/gitlab/data
+toolbox/gitlab/.env
+
 toolbox/utils/text-generator/_templates/new-GitHub-repository-contributors.fr.template.txt.result
 toolbox/utils/third-party-generator/components.csv.result
 toolbox/utils/third-party-generator/THIRD-PARTY.md.result
 toolbox/utils/third-party-generator/__pycache__
 toolbox/utils/_/__pycache__/
 toolbox/utils/reuse/.reuse/
+
 toolbox/LicensesInventory/.pytest_cache
 toolbox/LicensesInventory/sources/__pycache__
 toolbox/LicensesInventory/sources/*/__pycache__

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- GitHub and GitLab year review ([#181](https://github.com/Orange-OpenSource/floss-toolbox/issues/181))
 - Samples for common files to add in projects ([#184](https://github.com/Orange-OpenSource/floss-toolbox/issues/184))
 
 ## [2.21.0](https://github.com/Orange-OpenSource/floss-toolbox/compare/2.21.0..2.20.0) - 2024-09-164

LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,11 @@
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THIRD-PARTY.md

@@ -27,6 +27,15 @@ Copyright (c) 2009-2017 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
 *octokit.rb* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
 You may download the source code on the [following website](https://github.com/octokit/octokit.rb).
 
+### python-dotenv
+
+Version 1.0.1
+
+Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)
+
+*python-dotenv* is distributed under the terms and conditions of the [BSD 3-Clause License](https://opensource.org/license/BSD-3-clause).
+You may download the source code on the [following website](https://github.com/theskumar/python-dotenv).
+
 ### Ruby Git
 
 Version 1.18.0

toolbox/github/README.md

@@ -19,6 +19,7 @@ Table of Contents
          * [Get repositories which seems to be empty or have not enough files](#get-repositories-which-seems-to-be-empty-or-have-not-enough-files)
          * [Define users permissions for all projects to "push"](#define-users-permissions-for-all-projects-to-push)
          * [Define teams permissions for all projects to "push"](#define-teams-permissions-for-all-projects-to-push)
+         * [Make a year review of the GitHub organization](#make-a-year-review-of-the-github-organization)
    * [Play with GitHub CLI (GH)](#play-with-github-cli-gh)
       * [Prerequisites](#prerequisites-1)
       * [Prepare project](#prepare-project-1)
@@ -208,6 +209,38 @@ Permissions will be set to "read".
 bash GitHubWizard.sh set-teams-permissions-to-read
 ```
 
+### Make a year review of the GitHub organization
+
+_Keywords: #organisation #GitHub #KPI #year #review_
+
+You will need to define a *.env* file with the GitHub API token for key *GITHUB_API_TOKEN*, the organization name and some settings.
+Here the organization name is *Orange-OpenSource*, replace with your own and add the suitable token.
+
+See for example:
+```text
+GITHUB_API_TOKEN=your-token
+ORGANIZATION_NAME=Orange-OpenSource
+TOP_N_PROG_LANG=5
+TOP_N_LEAST_PROG_LANG=5
+TOP_N_LICENSES=5
+TOP_N_CONTRIBUTORS_OVERALL=10
+TOP_N_CONTRIBUTORS_FOR_YEAR=10
+TOP_N_REPOS_MOST_COMMITS=5
+```
+
+Run the following command to compute a year review of the organization
+
+```shell
+# Do not forget to install dependencies
+pip install -r requirements.txt
+
+# For year 2024
+python3.8 github-year-review.py --year 2024
+
+# For year 20°24 and commits counts computing (can be time expansive)
+python3.8 github-year-review.py --year 2024 --count-commits
+```
+
 # Play with GitHub CLI (GH)
 
 ## Prerequisites
@@ -304,4 +337,4 @@ brew install gitleaks
 
 You need to define in the _configuration.rb_ files the Github organisation at **GITHUB_ORGANIZATION_NAME** and also your GitHub personal token at **GITHUB_PERSONAL_ACCESS_TOKEN**.
 
-**You should also have your _git_ environment ready i.e. add your SSH private key if you clone by SSH for example. _gh_ must be installed, and _python3_ be ready. Obviously _gitleaks_ must be installed**
+**You should also have your _git_ environment ready i.e. add your SSH private key if you clone by SSH for example. _gh_ must be installed, and _python3_ be ready. Obviously _gitleaks_ must be installed**

toolbox/github/dry-run.sh

@@ -12,7 +12,7 @@
 
 # Since...............: 10/03/2023
 # Description.........: Make a dry-run of the github module to check if everything is ready to use
-# Version.............: 1.2.0
+# Version.............: 1.3.0
 
 set -eu
 
@@ -108,6 +108,10 @@ CheckIfFileExists "./utils/GitHubWrapper.rb"
 CheckIfFileExists "./utils/GitWrapper.rb"
 CheckIfFileExists "./utils/IO.rb"
 
+CheckIfFileExists "./github-year-review.py"
+CheckIfFileExists "./requirements.txt"
+CheckIfFileExists "./.env" # Warning: not versioned but mandatory for Python script above
+
 # Runtimes and tools
 # ------------------