MIT-LCP / MIT-LCP/wfdb-python

https://physionet.org/rest/database-list/ is being deprecated

Open
#439 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
853
Forks
322
PR merge metrics
No merged PRs in 30d

Description

As discussed in https://github.com/MIT-LCP/physionet-build/pull/1697, we plan to deprecate the database-list API on PhysioNet, in favour of a new API served from: /api/v1/. If/when https://physionet.org/rest/database-list/ is deprecated, the following function will break:

https://github.com/MIT-LCP/wfdb-python/blob/14248d17e87f3392ab87a30dc03013233414a3db/wfdb/io/download.py#L181-L212

When PhysioNet releases its new API (most likely at https://physionet.org/api/v1/), we should migrate the get_dbs to the new API (or perhaps deprecate get_dbs() and replace this with a new function).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the deprecation discussion in physionet-build#1697 and inspect wfdb/io/download.py at lines 181-212, where get_dbs uses the database-list endpoint. Check the replacement API at /api/v1/ when available and determine whether get_dbs should migrate or be replaced. Done means the database-list dependency is removed and the resulting API behavior is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.