Modulator - Module de modules

Présentation

Ce module donne accès à des outils qui permettent de créer des sous-module GeoNature.

Les modules sont listés sur la page d'accueil du module modulator.

Un exemple de sous-module est le module m_sipaf pour les passages à faune :

• page d'accueil du module m_sipaf avec une carte, liste et filtres des objets du sous-module :

• fiche détail et de saisie de chaque objet :

Installation

Compatible avec la version 2.13 de GeoNature.

• Téléchargez le module dans /home/<myuser>/, en remplacant X.Y.Z par la version souhaitée

cd
wget https://github.com/PnX-SI/gn_modulator/archive/X.Y.Z.zip
unzip X.Y.Z.zip
rm X.Y.Z.zip

• Renommez le répertoire du module

mv ~/gn_modulator-X.Y.Z ~/gn_modulator

• Lancez l'installation du module

source ~/geonature/backend/venv/bin/activate
geonature install-gn-module ~/gn_modulator MODULATOR
sudo systemctl restart geonature
sudo systemctl restart geonature-worker
deactivate

Installation de sous-modules

La commande suivante permet d'installer un sous-module :

geonature modulator install -p <chemin_du_module>
sudo systemctl restart geonature

Cette commande :

• installe le module python
• le module dans la base de données
• applique les migrations
• copie le dossier de configuration du sous-module dans le dossier /backend/media/modulator/config de GeoNature

Pour mettre à jour un sous-module, il faut relancer sa commande d'installation.

Le formalisme pour les codes des sous-modules est le suivante :

• en minuscule
• prefixé par m_
• par exemple m_sipaf

Des sous-modules sont déjà présents dans le dossier /config/modules/contrib :

• Installation du module SIPAF (passages à faune) :

  geonature modulator install -p <chemin vers gn_modulator>/contrib/m_sipaf

Mise à jour

Modulator

• Téléchargez la nouvelle version du module

  wget https://github.com/PnX-SI/gn_modulator/archive/X.Y.Z.zip
  unzip X.Y.Z.zip
  rm X.Y.Z.zip
  

• Renommez l'ancien et le nouveau répertoire

  mv ~/gn_modulator ~/gn_modulator_old
  mv ~/gn_modulator-X.Y.Z ~/gn_modulator
  

• Lancez la mise à jour du module

  source ~/geonature/backend/venv/bin/activate
  geonature install-gn-module ~/gn_modulator MODULATOR
  sudo systemctl restart geonature
  

Sous-module

Relancer la commande d'installation du module

geonature modulator install -p <chemin vers le sous-module>

Développement

Création d'un sous-module

Documentation sur la création d'un sous-module