Skip to content
Julien edited this page Jun 14, 2019 · 5 revisions

Structure du code

Dossier .vscode

Configuration pour l'éditeur Visual Studio Code :

  • extensions recommandées (extensions.json)
  • tâches (tasks.json)
  • paramètres d'environnement de travail sur le projet (tests, etc.) (settings.json)
  • paramètres de débogage (launch.json)

Dossier docs

Documentation sur le package :

  • celle générée automatiquement à partir du code et publiée sur Read The Docs (RTD)
  • les parties rédigées manuellement en ReStructured Text (.rst) pour donner des exemples d'usage, également publiés sur Read The Docs (RTD)
  • ce wiki ajouté en tant que sous-module git au projet

Dossier isogeo_pysdk

Package Python et ses dépendances.

Sous-dossier api

Méthodes correspondant aux routes de l'API.

Sous-dossier enums

Classes d'énumérations correspondant aux listes fermées des valeurs possibles de certains champs.

Sous-dossier models

Objets manipulés par l'API.

Sous-dossier samples

Exemples de scripts pour aider à la réutilisation du package.


Dossier tests

Tests unitaires et leurs fixtures.


Divers

  • .coveragerc: configuration pour le calcul de la couverture des tests (coverage / codecov)
  • example.env: modèle de fichier d'environnement à enregistrer sous
  • setup.py : configuration de l'installation du package