OpenFreeEnergy/alchemiscale

Add client-server version comparison check for major libraries

Aberta

#159 aberto em 3 de ago. de 2023

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Python (10 forks)auto 404
component-user-apicomponent-user-clientgood first issue

Métricas do repositório

Stars
 (35 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Implemente um método de verificação de versão no AlchemiscaleClient que obtém as versões locais de gufe, openfe e alchemiscale e as compara com as versões da API. Chame esse método ao instanciar o cliente para avisar sobre incompatibilidades, especialmente para diferenças de versão não patch.
Pilha de tecnologia
python
Domain
apibackend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70