ddi-l¶

ddi-l est une bibliothèque Python pour créer, lire, modifier et valider des documents XML DDI Lifecycle 3.3. Vous manipulez les études, les questions et les variables comme des objets Python, et ddi-l écrit et vérifie le XML.

Installer ddi-l Parcourir les recettes CLI

Démarrage rapide¶

import ddi_l as ddi

# Créer une nouvelle étude
doc = ddi.new_study(title="Enquête ménages", agency="example.org")

# Ajouter des questions
q = doc.add_question(text="Quel âge avez-vous ?")

# Ajouter des variables liées aux questions
doc.add_variable(name="Age", question=q)

# Enregistrer en XML
doc.save("enquete-menages.xml")

# Ouvrir une étude existante
doc = ddi.open_ddi("enquete-menages.xml")

for v in doc.variables:
    print(v.identifier)

Installer¶

Installez ddi-l avec pip ou Poetry. L'extra full ajoute le moteur lxml, plus rapide (voir Installation).

pipPoetry

pip install ddi-l

poetry add ddi-l
poetry run ddi --help

Pour continuer¶

Installer

Installez le paquet avec pip ou poetry et vérifiez qu'il fonctionne.

Guide d'installation →
Valider

Validez les documents par rapport aux schémas DDI, exécutez les règles de lint et ajoutez ces contrôles à la CI.

Guide de validation →
Rédiger

Construisez des documents DDI étape par étape avec l'API CRUD.

Tutoriels de rédaction →
Utiliser la CLI

Validez, faites l'aller-retour et convertissez des fichiers avec la commande ddi.

Recettes CLI →

Le site contient aussi un programme de formation en 16 modules, une référence de l'API et une référence des modèles. Pour contribuer, consultez le guide de développement et le guide des contributeurs.