OpenFreeEnergy/alchemiscale

Add client-server version comparison check for major libraries

Ouverte

#159 ouverte le 3 août 2023

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (10 forks)auto 404
component-user-apicomponent-user-clientgood first issue

Métriques du dépôt

Stars
 (35 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We should add a method to the AlchemiscaleClient that checks local versions of the following packages against those the API service is running with:

  • gufe
  • openfe
  • alchemiscale

We may call this method upon AlchemiscaleClient instantiation to issue warnings if mismatches are identified, especially for non-patch versions.

Guide contributeur

Direction de recherche
Implémentez une méthode de vérification de version dans AlchemiscaleClient qui récupère les versions locales de gufe, openfe et alchemiscale et les compare avec les versions de l'API. Appelez cette méthode lors de l'instanciation du client pour avertir des incompatibilités, en particulier pour les différences de version non patch.
Stack technique
python
Domaine
apibackend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70