Utilisation comme exécutable#
Configuration#
Pensez à créer un fichier de configuration indiquant au minimum vos identifiants.
Vérification de la configuration#
Un bon moyen de vérifier que la configuration est correcte est de s'authentifier via l'exécutable (commande auth) :
# Le fichier de configuration est directement trouvé s'il est
# nommé "config.ini" et qu'il est situé dans le dossier de travail
python -m sdk_entrepot_gpf auth
# Sinon indiquez son chemin
python -m sdk_entrepot_gpf --ini /autre/chemin/config.ini auth
Cela devrait renvoyer :
Mes datastores#
Dans la configuration, vous devez indiquer l'identifiant du datastore à utiliser.
Si vous ne le connaissez pas, il est possible de lister les communautés auxquelles vous appartenez et, pour chacune d'elles, le datastore qui lui est associé.
La commande me permet de lister les communautés auxquelles vous appartenez :
Cela devrait renvoyer :
Vos informations :
* email : prenom.nom@me.io
* nom : Prénom Nom
* votre id : 11111111111111111111
Vous êtes membre de 1 communauté(s) :
* communauté « Bac à sable » :
- id de la communauté : 22222222222222222222
- id du datastore : 33333333333333333333
- nom technique : bac-a-sable
- droits : community, uploads, processings, datastore, stored_data, broadcast
Dans cet exemple, l'identifiant du datastore à utiliser est 33333333333333333333.
Attention !
Cela ne fonctionnera que si les autres paramètres (nom d'utilisateur, mot de passe et urls) sont corrects.
Afficher toute la configuration#
Vous pouvez afficher toute la configuration via une commande. Cela peut vous permettre d'avoir une liste exhaustive des paramètres disponibles et de vérifier que votre fichier de configuration a bien le dernier mot sur les paramètres à utiliser.
Affichez la configuration (commande config) :
# Toute la configuration
python -m sdk_entrepot_gpf config
# Une section
python -m sdk_entrepot_gpf config -s store_authentification
# Une option d'une section
python -m sdk_entrepot_gpf config -s store_authentification -o password
Récupérer des jeux de données d'exemple#
Il est possible de récupérer des jeux de données d'exemple via l'exécutable avec la commande dataset.
Lancez la commande dataset sans paramètre pour lister les jeux disponibles :
Lancez la commande dataset en précisant le nom (-n) du jeu de données à extraire pour récupérer un jeu de données :
Les données seront extraites dans le dossier courant, vous pouvez préciser la destination avec le paramètre --folder (ou -f).
Envoyer des données#
Pour envoyer des données, vous devez générer un fichier descripteur de livraison.
C'est un fichier au format JSON permettant de décrire les données à livrer et les livraisons à créer.
Ensuite, vous pouvez simplement livrer des données avec la commande upload :
Les jeux de données d'exemple sont fournis avec le fichier descripteur (voir Récupérer des jeux de données d'exemple).
Réaliser des traitements et publier des données#
Pour réaliser des traitements et publier des données géographiques, vous devez générer un fichier workflow.
C'est un fichier au format JSON permettant de décrire, en une suite d'étapes, les traitements et les publications à effectuer.
Vous pouvez valider votre workflow :
Ensuite, vous pouvez simplement lancer une étape :
Tutoriels#
Vous pouvez maintenant livrer et publier vos données en utilisant le module comme un exécutable. Voici quelques exemples :