maj doc et version

README.md

@@ -1,3 +1,47 @@
-# mncheck
-
-Plugin QGis de contrôle des données FTTH format MN
+# MnCheck
+
+*Plugin QGis de contrôle des données FTTH format MN*
+
+> Note: **MnCheck** est fourni sans garantie d'exhaustivité et ne dispense pas l'opérateur de tout contrôle complémentaire qu'il jugerait nécessaire.
+
+### Pré-requis
+
+* QGis 3.0+
+
+
+### Installer MnCheck
+
+Depuis l'interface de QGis: `Menu > Extension > Installer/Gérer des extensions > Installer depuis un ZIP`
+
+Sélectionner le fichier ZIP `MnCheck_XXX.zip`, puis cliquer sur 'Installer le plugin'.
+
+Un message devrait vous informer de la bonne installation du plugin, et le bouton suivant a dû 
+s'ajouter à votre barre d'outils: ![icon.png](icon.png) 
+
+
+### Utiliser MnCheck
+
+Pour exécuter le contrôle des données, lancer **MnCheck** via le bouton de la barre d'outils ou via le menu Extensions.
+
+Sélectionner ensuite le schéma de données à appliquer
+
+Vérifier que toutes les couches attendues sont présentes, les ajouter si nécessaire.
+
+Cliquer sur 'lancer' (bouton lecture).
+
+Une fois le traitement terminé, la liste des tests effectués s'affiche.
+
+En cas d'erreur, déplier la liste et cliquer sur une erreur pour zoomer sur l'élément concerné.
+
+
+### Signaler un problème ou proposer une amélioration
+
+Si vous repérez ce qui semble être un bug, ou si vous avez une suggestion d'amélioration, vous pouvez la soumettre à [sig@manchenumerique.fr](mailto:sig@manchenumerique.fr)
+
+**En toute occasion, assurez-vous d'avoir la dernière version de l'extension installée**
+
+Pensez à joindre à votre message toutes les informations potentiellement utile, généralement:
+
+* Le livrable au format zip
+* Une ou plusieurs captures d'écran
+* Les fichiers de log

core/constants.py

@@ -6,6 +6,9 @@
 '''
 from path import Path
 
+VERSION = "0.4.0"
+
+
 MAIN = Path(__file__).parent.parent.abspath()
 
 RSCDIR = MAIN / "ui" / "rsc"

main.py

@@ -16,17 +16,17 @@ from PyQt5.QtGui import QIcon
 from PyQt5.QtWidgets import QAction
 
 from core import logging_
-from core.constants import MAIN
+from core.constants import MAIN,VERSION
 from ui.dlg_main import DlgMain
 
-
-__VERSION__ = "0.1.0"
+__VERSION__ = VERSION
 
 logger = logging.getLogger("mncheck")
 logging_.start("mncheck", logging.DEBUG)
 
 
 logger.info("* loading plugin")
+logger.info(f"version: {VERSION}")
 
 class MnCheck:
     def __init__(self, iface):

metadata.txt

@@ -10,7 +10,7 @@
 name=MnCheck
 qgisMinimumVersion=3.0
 description=Contrôle des données FTTH format MN
-version=0.1
+version=0.4
 author=Manche Numérique 2019
 email=olivier.massot@manchenumerique.fr
 
@@ -28,11 +28,11 @@ repository=http://lxc-p-web-2:8001/omassot/mncheck
 # Tags are comma separated with spaces allowed
 tags=python
 
-homepage=http://homepage
+homepage=http://www.manchenumerique.fr/
 category=Plugins
 icon=icon.png
 # experimental flag
-experimental=True
+experimental=False
 
 # deprecated flag (applies to the whole plugin, not just a single version)
 deprecated=False

ui/dlg_main.py

@@ -12,7 +12,7 @@ from PyQt5.QtGui import QIcon, QPixmap
 from PyQt5.QtWidgets import QApplication, QTreeWidgetItem
 
 from core.checking import TestResult
-from core.constants import MAIN, RSCDIR
+from core.constants import MAIN, RSCDIR, VERSION
 from ui.dlg_contact import DlgContact
 
 
@@ -45,6 +45,7 @@ class DlgMain(QtWidgets.QDialog):
         self.ui = Ui_Main()
         self.ui.setupUi(self)
         
+        self.setWindowTitle(f"MnCheck v{VERSION}")
         self.setWindowIcon(QIcon(MAIN / "icon.png"))
         
         self.ui.btn_run.setIcon(QIcon(RSCDIR / "play.png"))
@@ -53,10 +54,6 @@ class DlgMain(QtWidgets.QDialog):
         self.ui.btn_help.setIcon(QIcon(RSCDIR / "question.png"))
         self.ui.btn_help.clicked.connect(self.show_help)
         
-        self.ui.btn_settings.setIcon(QIcon(RSCDIR / "settings.png"))
-        self.ui.btn_settings.clicked.connect(self.show_settings)
-        
-        self.ui.btn_settings.setIcon(QIcon(RSCDIR / "settings.png"))
         self.ui.btn_contact.clicked.connect(self.show_contact)
 
         for i, schema_name in enumerate(self.available_schemas):