Skip to content

Get Started

Modes

Il y a 2 modes d'utilisation de cglblens:

Dans les 2 cas d'usage, l'utilisation de fichiers de configuration cglblens.yml est recommandé mais non obligatoire.

Pour connaitre toutes les options de configuration, veuillez vous reporter à la documentation Configuration

Dépôt de démonstrations

Des exemples complets de démonstrations sont disponibles ici:

https://github.com/CesGensLaB/cglblens-demo

En ligne de commande

Voici un exemple simple (sans fichier de configuration) où l'on compare 2 fichiers texte et l'on produit un rapport HTML.

1. Créer les Fichiers

/mytest
    /reference
        data.txt
    /test
        data.txt

Value A: 1
Value B: 2
Value C: 3

Value A: 1
Value B: 2
Value C: 9

2. Exécuter cglblens run

Dans le répertoire mytest

cglblens run --processor Compare --export-html --report-title "Get Started !" .

Cela générera un fichier cglblens_report.html que vous pouvez ouvrir dans un navigateur web.

En ligne de commande (avec fichier de configuration)

Voici un exemple simple (avec fichier de configuration) où l'on compare 2 fichiers texte et l'on produit un rapport HTML.

1. Créer les Fichiers

/mytest
    /reference
        data.txt
    /test
        data.txt
    cglblens.yml

Value A: 1
Value B: 2
Value C: 3

Value A: 1
Value B: 2
Value C: 9

processor: Compare
report:
  title: "Get Started !"
  output:
    export_html: true

2. Exécuter cglblens run

Dans le répertoire mytest

cglblens run .

Cela générera un fichier cglblens_report.html que vous pouvez ouvrir dans un navigateur web.

En python

Voici un exemple simple (sans fichier de configuration) où l'on compare 2 fichiers texte et l'on produit un rapport HTML.

1. Créer les Fichiers

/mytest
    /reference
        data.txt
    /test
        data.txt
    run.py

Value A: 1
Value B: 2
Value C: 3

Value A: 1
Value B: 2
Value C: 9

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import os

from cglblens import StandaloneTaskRunner


SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))

config = {
    "processor": "Compare",
    "report": {
        "title": "Get Started !",
        "output": {
            "export_html": True
        }
    }
}

runner = StandaloneTaskRunner(config)
results = runner.process(SCRIPT_DIR, origin_working_dir=SCRIPT_DIR)

if results.error:
    raise Exception(results.error)
else:
    # here we expect no errors and no warnings
    # but this demo will raise an AssertionError
    assert not results.processor_results.errors and not results.processor_results.warnings

2. Exécuter le script python

python run.py
  • une exception AssertionError sera levée
  • un rapport cglblens_report.html sera généré que vous pouvez ouvrir dans un navigateur web.

En python (avec fichier de configuration)

Voici un exemple simple (avec fichier de configuration) où l'on compare 2 fichiers texte et l'on produit un rapport HTML.

1. Créer les Fichiers

/mytest
    /reference
        data.txt
    /test
        data.txt
    cglblens.yml
    run.py

Value A: 1
Value B: 2
Value C: 3

Value A: 1
Value B: 2
Value C: 9

processor: Compare
report:
  title: "Get Started !"
  output:
    export_html: true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import os

from cglblens import StandaloneTaskRunner


SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))

runner = StandaloneTaskRunner(f"{SCRIPT_DIR}/cglblens.yml")
results = runner.process(SCRIPT_DIR, origin_working_dir=SCRIPT_DIR)

if results.error:
    raise Exception(results.error)
else:
    # here we expect no errors and no warnings
    # but this demo will raise an AssertionError
    assert not results.processor_results.errors and not results.processor_results.warnings

2. Exécuter le script python

python run.py
  • une exception AssertionError sera levée
  • un rapport cglblens_report.html sera généré que vous pouvez ouvrir dans un navigateur web.

CesGensLaB