Giter Club home page Giter Club logo

gn_module_export's Introduction

Module export

Module permetant d'ajouter de fonctionnalités d'export à l'application GéoNature

Fonctionnalités principales

  • Interface administrateur de gestion des exports
  • Interface utilisateur permettant de réaliser des exports
  • API d'Interrogation des exports
  • Export nocture des exports [TODO]
  • Export RDF au format Darwin-SW [TODO]

Installation du module

Configuration

Mail

Le module d'export envoie des mails indiquant que l'export demandé est près. Pour cela il est nécessaire de configurer les paramètres mail dans la configuration générale de GéoNature (config/geonature_config.toml).

La configuration des mails utilise les paramètres définis pas Flask_mail. Pour avoir accès à l'ensemble des paramètres se référer à la documentation complète.

[MAIL_CONFIG]
    MAIL_SERVER = "monserver.mail"
    MAIL_PORT = 465 # Si différent de 465 en SSL
    MAIL_USERNAME = "[email protected]"
    MAIL_PASSWORD = "password"
    MAIL_DEFAULT_SENDER = "[email protected]"

Commande d'installation

  • Faire un lien symbolique vers le répertoire node_modules de GeoNature
ln -s /home/`whoami`/geonature/frontend/node_modules /home/`whoami`/gn_module_export/frontend
  • Lancer l'installation du module
source backend/venv/bin/activate
geonature install_gn_module /PATH_TO_MODULE/gn_module_export exports

Pour avoir des exports disponibles il faut les renseigner au niveau de la base de données dans la table gn_exports.t_exports.

Administration du module

Création d'une nouvelle vue en base

Pour créer un nouvel export il faut au préalable créer une vue dans la base de données correspondante à l'export désiré.

Pour des questions de lisibilité il est conseillé de créer la vue dans le schéma gn_export

Enregistrer l'export créé dans l'admin

L'interface d'administration est accessible dans Géonature via le menu admin puis backoffice GeoNature

Dans la rubrique Exports selectionner le menu Export puis cliquer sur create et renseigner les valeurs

Associer les roles ayant la permission d'accéder à cet export

Aller sur la page : Associer roles aux exports

Puis créer des associations entre les rôles et l'export en question

Seul les roles ayant des emails peuvent être associé à un export exception faite des groupes

Documentation swagger d'un export

Par défaut une documentation swagger est générée automatiquement mais il est possible de la surcharger en respectant certaines conventions.

  1. Créer un fichier au format open api dévrivant votre export
  2. Sauvegarder le fichier geonature/external_modules/exports/backend/templates/swagger/api_specification_{id_export}.json

Autres

CCTP de définition du projet - http://geonature.fr/documents/cctp/2017-10-CCTP-GeoNature-interoperabilite.pdf

A voir aussi : https://www.indigo-datacloud.eu

Ainsi que : https://fr.wikipedia.org/wiki/Syst%C3%A8me_d'information_taxonomique_int%C3%A9gr%C3%A9

Pour le volet Taxonomie, un travail expérimental a été réalisé : PnX-SI/TaxHub#150

Mise à jour du module

  • Téléchargez la nouvelle version du module

    wget https://github.com/PnX-SI/gn_module_export/archive/X.Y.Z.zip
    unzip X.Y.Z.zip
    rm X.Y.Z.zip
    
  • Renommez l'ancien et le nouveau répertoire

    mv /home/`whoami`/gn_module_export /home/`whoami`/gn_module_export_old
    mv /home/`whoami`/gn_module_export-X.Y.Z /home/`whoami`/gn_module_export
    
  • Rappatriez le fichier de configuration

    cp /home/`whoami`/gn_module_export_old/config/conf_gn_module.toml   /home/`whoami`/gn_module_export/config/conf_gn_module.toml
    
  • Refaire le lien symbolique vers les node_modules

    ln -s /home/`whoami`/geonature/frontend/node_modules /home/`whoami`/gn_module_export/frontend
    
  • Relancer la compilation en mettant à jour la configuration

    cd /home/`whoami`/geonature/backend
    source venv/bin/activate
    geonature update_module_configuration EXPORTS
    

gn_module_export's People

Contributors

amandine-sahl avatar cdcvidal avatar camillemonchicourt avatar theolechemia avatar vpilorge avatar citizenu03bb avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.