OpenFreeEnergy/alchemiscale

Add client-server version comparison check for major libraries

Open

#159 opened on Aug 3, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (10 forks)auto 404
component-user-apicomponent-user-clientgood first issue

Repository metrics

Stars
 (35 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Implement a version check method in AlchemiscaleClient that retrieves local versions of gufe, openfe, and alchemiscale, and compares them with the API's versions. Call this method upon client instantiation to warn about mismatches, especially for non patch version differences.
Tech stack
python
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70