OpenFreeEnergy/alchemiscale

Add client-server version comparison check for major libraries

Aperta

#159 aperta il 3 ago 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (10 fork)auto 404
component-user-apicomponent-user-clientgood first issue

Metriche repository

Star
 (35 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Implementa un metodo di controllo della versione in AlchemiscaleClient che recupera le versioni locali di gufe, openfe e alchemiscale e le confronta con le versioni dell'API. Chiama questo metodo all'istanziazione del client per avvisare di discrepanze, specialmente per differenze di versione non patch.
Tech stack
python
Dominio
apibackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70