OpenFreeEnergy/alchemiscale

Add `limit` and `skip` to all `AlchemiscaleClient.query_*` methods

Open

#149 opened on Jun 20, 2023

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

Repository metrics

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

Description

We currently do not implement limit and skip kwargs on AlchemiscaleClient.query_* methods. These will be needed for users querying a large database, as we do not want an arbitrarily-large number of returned results.

The default for limit should be set to e.g. ~1000 as a client-side parameter, with some configurable upper bound set on query API endpoints. The default for skip should be 0.

Contributor guide

Research direction
Examine the existing query methods in the AlchemiscaleClient class and add `limit` and `skip` keyword arguments with defaults (e.g., limit=1000, skip=0). Modify the corresponding server side API endpoints to accept these parameters and enforce a configurable maximum limit. Update tests and documentation to reflect the changes.
Tech stack
python
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
60