Faire de UHAM un package autonome

[ksamuel]

Bonjour Amandine,

Samuel Priou m'a donné pour mission de créer un logiciel pour gérer les autorisations de circulation sur le parc du Mercantour. L'une des demandes est d'utiliser UsersHub pour gérer les comptes utilisateur, et il m'a redirigé sur ton module comme solution adaptée à Python.

Comme nous utilisons Flask et SQLAlchemy, tes modèles et routes sont en effet un bon point de départ pour l'authentification dans notre projet.

Néanmoins dans sa structure actuelle le projet est fait pour être utilisé comme un submodule de TaxHub. Il part du principe que ce dernier est installé, utilisant notamment des effets de bords du fichiers server.py, et supposant que le schema de la base postgres est déjà en place.

Afin de pouvoir bénéficier du code de ton projet, j'ai travaillé à en faire un package autonome. Voici un résumé des aménagements :

• Déplacement du contenu de models.py et routes.py dans un dossier 'src'.
• Transformation en package avec les fichiers setup.py / MANIFEST.
• Embarquement des schemas et fixtures SQL pour initialiser la bdd sans TaxHub.
• Decouplage du code de TaxHub's, notamment server.db et server.init_app()
• Déplacement de la gestion de l'expiration des cookies au niveau d'activation du blueprint.
• Déplacement du binding de l'app Flask et l'objet db de SQLA au niveau d'activation du blueprint.
• Ajouts de settings pour ces deux comportements.
• Création de commandes pour initialiser le schema de la bdd.
• Utilisation d'un idiome de programmation compatible Python 2 et 3.
• Ajout de documentation sur la procédure d'initilisation de la bdd.

J'en ai profité pour faire quelques corrections PEP8.

Comme je ne voulais pas casser les projets existant, j'ai mis en places quelques mesures pour pouvoir encore utiliser le projet comme submodule dans TaxHub:

• des alias pour models.py et routes.py dans le dossier racine.
• l'alias routes.py appelle server.init_app()
• les valeurs de configuration par défaut vise TaxHub. Pour l'utiliser hors de TaxHub, il faut volontairement faire une certaine configuration.

J'aimerais voir avec toi si il est possible de merger ces modifications dans ton projet original à travers cette PR. Si il y a des modifications à apporter pour le permettre, je suis disposé à les faire.

Avant cela néanmoins, je n'ai pas eu la possibilité de tester le projet sur TaxHub (je n'ai pas de documentation pour l'installer). N'ayant pas non plus de tests unitaires à lancer dans les deux projets, il m'est difficile de valider le code que je propose. Si cette PR t'interesse, pourrais-tu vérifier si je casse quelque chose en installant mon code sur une machine de test avec TaxHub en tant que submodule (comme vous faites en prod) et voir si ça marche comme prévu ?

Si tout se passe bien et que le projet continue de marcher avec TaxHub, les prochaines étapes seraient:

• Changer le setup.py pour te mettre en auteur de telle sorte que tu sois le contact officiel.
• Ajouter un fichier CONTRIBUTORS pour déplacer mes contacts dedans.
• Uploader le projet sur pypi pour permettre de l'installer avec pip.
• Rajouter un peu de doc pour que les prochains projets des parc nationaux puissent l'utiliser facilement.

Je suis disponibles les prochains jours afin de pouvoir discuter de tout cela.

Cordialement,

Kevin

[camillemonchicourt]

Merci pour ces éléments et ce travail. En effet à terme, il faudrait même que ce sous-module soit complètement déconnecté de TaxHub. TaxHub est utilisé au PNM pour la gestion de la taxonomie de GeoNature. Sinon le projet est ici : https://github.com/PnX-SI/TaxHub et la doc ici : http://taxhub.readthedocs.io (pas revue depuis un moment).

[gildeluermoz]

Merci pour cette contribution. Je laisse Amandine l'analyser sur le plan technique. Sur le plan stratégique et conceptuel, il me semble intéressant de faire de ce sous module un module d'authentification générique et autonome. En effet, le module d'authentification peut/doit avoir sa propre connexion à une base UsersHub, indépendamment de l'application qui utilise ce module. Il peut fonctionner de manière autonome (connexion et modèle de données) et récupérer les informations nécessaires à l'authentification sur une base qui n'est pas celle de l'application métier. Ceci permet d'envisager de l'utiliser dans une application qui n'aurait pas besoin d'embarquer dans sa base le schéma utilisateurs de UsersHub.