isogeo / sandbox-python Goto Github PK

• Documenter les labels
• Décrire succinctement le projet dans le README
• Ajouter une description
• Ajouter des mots-clefs

Voir http://help.isogeo.com/api/fr/methods/terms.html

https://github.com/isogeo/isogeo-plugin-qgis/issues/new

• identifier la requête à utiliser
• vérifier que la fonction est bien paramétrée pour
• tester avec plusieurs valeurs possibles

Pour reproduire :

1. Lancer le moteur de recherche
2. Effectuer une recherche
3. Modifier un partage (par exemple en ajoutant une métadonnée au catalogue)
4. Cliquer sur le bouton reset

=> le nombre de résultat n'est plus cohérent

En se basant sur les docstrings et en utilisant Sphinx.

• utiliser shpinx-apidoc (et automodule)
• ajouter les type hints

voir ici

• Récupérer les sorties de tous les widgets
• Les formater

Sur le modèle de https://github.com/isogeo/isogeo-api-py-minsdk/wiki

Indice : le wiki est un dépôt Git comme un autre

• Ajouter un fichier listant les dépendances

• Indiquer dans le wiki comment répliquer le même environnement

• Structurer le dépôt pour stocker des modules

Afin de faciliter le support, un fichier journal est écrit au fur et à mesure des actions de l'utilisateur.

2 niveaux possibles :

• INFO : seulement les messages de base (informatifs...)
• DEBUG : tous les messages

Description du fonctionnement attendu : spécification technique et fonctionnelle (mini CCTP)

• normaliser les noms de fichiers et dossiers, ainsi que des classes
• nettoyer les doublons (CQFD intérêt du versioning)
• structure attendue :
  • api/api_client.py
  • ui/ui_objs.py
  • main_search_engine.py
• documenter le wiki https://github.com/isogeo/sandbox-python/wiki/Code

• Identifier les paramètres de la méthode search()

• Réfléchir à la distinction entre les catégories de requêtes :

  • la requête initiale d'allumage
  • les requêtes de remplissage des widgets
  • les requêtes d'actualisation des widgets
  • la requête finale d'obtention du résultat

Ajouter un bouton reset global à la place du bouton "Lancement de l'inventaire" spécifié #8 comme indiqué lors de la première itération #21

• modifier user_interface.py dans connection

• adapter moteur_de_recherche.py

Utiliser la dernière version du package isogeo-pysdk

La requête à l'API ne doit pas être effectuée à chaque fois que l'utilisateurs appuie sur une touche du clavier mais :

• Au bout de 5 seconde

ou

• Lorsqu'il change le focus

Pour éviter les combinaisons vides

• identifier la requête pour chaque widget
• connecter la sortie des widgets à la requête d'actualisation
• connecter la sortie de la requête de remplissage aux widgets

Ajouter, en plus du bouton reset global (#23 ) des boutons reset individuels propres à chaque filtre, comme spécifié lors de la seconde itération #24

• modifier user_interface.py dans connection

• adapter moteur_de_recherche.py

• Récupérer le token
• Récupérer une instance Isogeo
• En faire les propriétés d'une classe

• écriture
• automatisation (réflexion input/output)
• factorisation des méthodes selon le type de requête

• Dessiner l'interface utilisateur

• Dessiner le scénario d'utilisateur

• Inclure les images ici

Dans le README

Contexte

L'API Isogeo en lecture permet d'effectuer des recherches filtrées dans les inventaires de métadonnées des clients.
Son utilisation requiert des compétences en développement.

Objectifs

1. Créer une interface graphique permettant d'utiliser l'API sans avoir de compétences de développement.

2. Valoriser le package isogeo-pysdk en proposant une application concrète.

Description

L'interface se lance à partir d'un script Python (3.7) qui doit fonctionner au moins sous Windows 10. Elle permet de filtrer les métadonnées accessibles selon différents champs et de savoir combien correspondent à la sélection.

Authentification

Le script Python doit être stocké dans un dossier contenant un fichier json d'authentification Isogeo intitulé "client_secrets.json".

Champs de filtre

Les champs de filtre correspondent à certains filtres sémantiques permettant d’exécuter une recherche via l'API Isogeo (voir la doc de l'API). On peut filtrer les métadonnées en fonction de :

• Mots-clefs associés
• Groupe de travail
• Type de ressource
• Format source
• Fournisseur

Interface de filtre

Les champs ne possèdent pas le même nombre d'entrées ce qui implique d'utiliser deux interfaces de sélection différentes :

• Barre de recherche à autocomplétion pour la sélection des Mots-clefs.
• Menu déroulant de sélection pour les autres champs.

Au lancement du script, l'interface apparaît et une requête est effectuée via l'API Isogeo pour obtenir les modalités des champs de filtre et ajouter les options dont dispose l'utilisateur aux widgets de sélection.

Récupération et affichage du résultat

Quand l'utilisateur a effectué sa sélection, il lui reste à cliquer sur un bouton qui lance la requête permettant de connaître le nombre de métadonnées correspondantes. Cette requête est générée à partir de la combinaison des options sélectionnées dans les différents champs de filtre. Le nombre de métadonnées filtrées est extrait du résultat de la requête et affiché dans l'interface.

Spécifications techniques

• La version 3.7 de Python est utilisée.
• La version 2.20.5 du package isogeo-pysdk est utilisée.
• Le package tkinter est utilisé pour générer l'interface afin de minimiser les dépendances externes.

Objectifs optionnels

1. Asynchronie : L'affichage du résultat doit s'actualiser en temps réel et apparaître rapidement. De plus, les modalités des champs de sélection doivent également s'actualiser en fonction des options choisies dans les autres champs.

2. Authentification dynamique : Plutôt que de demander à l'utilisateur de stocker le script au même endroit que son fichier json d'authentification, il doit pouvoir accéder à ce fichier via l'interface, quelque soient son emplacement et son intitulé.

https://github.blog/2013-01-22-closing-issues-via-commit-messages/

• Pouvoir les lancer avec unittest ou pytest.
• bonux : calculer le taux de couverture