Move viral collections onto DataCache's download/build split

Aperta
#159 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
cli, tooling

Direzione di ricerca

Read viral_panel.py, net.py, and the VersionedDatasetRegistry implementation to understand the existing build and download flows. Trace how data fetch gdc-viruses handles options and registered artifacts. Done means it uses a pinned artifact when available, builds otherwise, routes content-changing options to the build path, and meets the stated request handling and user-agent requirements.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Catalogues and datasets are either a published, checksummed artifact downloaded through DataCache, or a local build from pinned sources. The gdc-viruses collection uses a separate stack:

  • live NCBI EFetch and PaVE requests through net.py (urllib with its own retries);
  • its own SHA256SUMS, staging and verification in viral_panel.py.

Every install depends on NCBI and PaVE being reachable and within their rate limits. net.py ignores Retry-After and has no NCBI_API_KEY support, and its user agent is hard-coded as orfdata/viral.

Proposal: publish the built collection as a release artifact where the record sources' terms allow, and install it through VersionedDatasetRegistry. Keep the live fetch as the build route with the existing ledgers and checksums. This would give viral collections the same list/info/fetch/path semantics, repair policy and resume behavior as every other resource, as the no-sidecars rule asks.

Acceptance: data fetch gdc-viruses downloads a pinned artifact when one is registered and builds otherwise. Options that change the content (--inventory-molecules, --no-annotation-fill, --alternate-annotations) select the build route. net.py honours Retry-After, and the request user agent no longer names the viral module.

#158 fixes the non-atomic replacement on its own; this issue removes the separate stack.

Lingua principale
Python
Stelle
1
Fork
1
Merge medio
10h 11m
PR unite (30g)
51

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openvax/orfdata

Tutte le issue di openvax/orfdata

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.