ISA-tools / ISA-tools/isa-api

create a helper function to compute checksums for all 'Data File' objects

Open
#512 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
48
Forks
42
PR merge metrics
No merged PRs in 30d

Description

  • use hashlib
  • use file uri as input
  • request checksum type from user (default to sha2 or md5)
  • add 2 Comments[] to each ISA DataFile object
    - [ ] Comment[checksum type]
    - [ ] Comment[Checksum]
  • include a flag in the serialization function to request if checksums should be generated or recalculated (avoid to recompute checksum everytime isa objects are serialized

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

Start by locating the ISA DataFile object definition and the serialization function. Check how file URIs and Comments[] are represented, then define done as generating the requested checksum type only when serialization requests it, preserving existing checksums otherwise.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.