Skip to content

Design an API to query data from AmpRepo #549

@jluebeck

Description

@jluebeck

Programmatic download of projects

CLI API (perhaps python-based) that allows a user to

  1. authenticate via username + user-specific site-generate API token (revokable by admins)
  2. list public and private projects the user has access to, giving the the project name, ID, description, number of samples
  3. allow user to download the .tar.gz project file given the ID (batch mode if you give it a list of IDs)
  4. allow user to get the metadata dictionary for a project

Implementation:
Rest API, so one can use CURL. If needed we develop a python-based API.

Search-based download of samples

Do we need this if the user can just do it from the website?

TBD:

  • API allows user to query project to get list of sample names - do they need metadata to figure out what samples they want?
  • allow user to download specific samples from a project given the the UUID and a list of sample names

For reference, files used by Siavash LLM:
agregated_result.csv
all anotated cycle files
all graph files.
AC gene_list.tsv
AC *_SV_summary.tsv files

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions