nf-core / nf-core/tools

pathlib adoption roadmap and summary issue

Open
#1,703 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

PR #1700 grew too big and this is now an issue collecting the information about the adoption to pathlib.

From PR #1700
  • provide ansi code stripping from utils d91b6f6
    • #1707
  • remove unused import e756ea4 and 330248d
    • #1706
  • minor improvements ef56745
    • This and more #1747
  • fix repeated test name 357692e
    • #1704
  • use pathlib Path 672b7a5 and 9eb7340
  • make md5 checksum validation a static method 4aaf4b7
    • #1734

Parts in nf_core that are potentially affected by pathlib adoption:

  • nf-core tools
  • nf-core list
  • nf-core launch
  • nf-core download
  • nf-core licences
  • nf-core create
  • nf-core lint
  • nf-core schema
  • nf-core bump-version
  • nf-core syn
  • nf-core module
    • modules lis
    • modules list remot
    • modules list loca
    • modules instal
    • modules updat
    • modules remov
    • modules creat
    • modules create-test-ym
    • modules lin
    • modules tes
    • modules bump-version
    • modules mulle

Contributor guide

Open the contributing guide

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 reviewing PR #1700 and the unchecked pathlib adoption items, then inspect the affected nf-core commands listed in the issue. Track each command and module area that still needs migration, and consider the work done when the listed adoption scope is completed without regressions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.