OpenFreeEnergy/alchemiscale

Add client-server version comparison check for major libraries

Offen

#159 geöffnet am 03.08.2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (10 Forks)auto 404
component-user-apicomponent-user-clientgood first issue

Repository-Metriken

Stars
 (35 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Implementieren Sie eine Versionsprüfungsmethode in AlchemiscaleClient, die die lokalen Versionen von gufe, openfe und alchemiscale abruft und mit den API Versionen vergleicht. Rufen Sie diese Methode bei der Client Instanziierung auf, um vor Abweichungen zu warnen, insbesondere bei Nicht Patch Versionsunterschieden.
Tech Stack
python
Domain
apibackend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70