Lizenzprüfer

Ein Skript zur Extraktion von Importanweisungen, Codeblöcken und Lizenzinformationen aus Jupyter-Notebooks und Python-Dateien. Ebenfalls wird Copyleft erkannt.

Verwendung

Dieses Skript kann entweder über die Befehlszeile (Terminal) oder in GitHub Actions verwendet werden.

Befehlszeile (Terminal)

Installation der benötigten Pakete:

pip3 install -r requirements.txt

Starten des Skripts:

python3 check_licenses.py <directory_to_search_in>

GitHub Actions

Erstellen Sie eine .github/workflows/main.yml-Datei, indem Sie zu den "Actions" gehen und dann "set up a workflow yourself" auswählen. Fügen Sie den folgenden Inhalt ein:

name: Python Lizenzprüfer
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: checkout repo content
        uses: actions/checkout@v2 

      - name: setup python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: install python packages
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: execute py script 
        run: python check_licenses.py <directory_to_search_in>

Durch die Verwendung dieses GitHub Actions-Workflows wird das Skript automatisch bei Push-Vorgängen auf den Hauptzweig (main) Repositories ausgeführt.

Verifizieren

Um das Skript zu verifizieren, kann folgendes Kommando gestartet werden, es extrahiert die Lizenz für ein installiertes Packages auf dem lokalen Computer.

pip3 show <license-name> -v | grep -i license

Bekannte Probleme

• Das Skript extrahiert die Libraries aus dem Code Block eines Notebooks oder Python Files, es ist also nicht möglich zu sagen, welche Version einer Library überprüft wird. Schließlich kann jeder User eine andere Version von Python und Libraries installiert haben, und dennoch den Code verwenden.
• PyPi ist ein Python Package Index Tool, welches nahezu alle Python Libaries findet, jedoch nicht alle.
• Ebenfalls liefert PyPi manchmal eine andere Lizenz wie es obige Verifizierungs Komando macht. So hat NumPy laut PyPi eine BSD-Lizenz, laut dem obigen Komando aber eine GPL-Lizenz. Problematisch weil die GPL-Lizenz unter die Copyleft Klausel fällt (unerwünscht).
• Das Verifizierungs Komando ist keine Alternative zu der PyPi Problematik, weil damit keine Github Actions mehr möglich sind.