INCATools / INCATools/ontology-access-kit

split cli.py into sub-packages

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

Nobody has claimed this yet.

design
Dominant language
Python
Stars
198
Forks
35
Avg merge
3d 4h
Merged PRs (30d)
1

Description

it's getting a little unwieldy

there is also some work to move some of the logic in there for processing multi-term arguments, but that is a separate piece of work

We could have one package per command:

  • cli
    • viz
    • tree
    • info
    • ...

or we could modularize by interface

  • interfaces
    • basic_ontology_interface <- info, search, etc go here
    • obograph_interface <- viz, tree, ancestors, etc go here
    • etc

or parallel:

  • cli
    • basic_cli
    • obograph_cli
    • ...

See:

https://stackoverflow.com/questions/34643620/how-can-i-split-my-click-commands-each-with-a-set-of-sub-commands-into-multipl

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 reading cli.py and cataloging its commands and shared logic. Compare the proposed command-based, interface-based, and parallel package layouts, noting that multi-term argument processing is separate work. Done means the CLI is split into agreed sub-packages without taking on that separate argument-processing change, with existing commands still accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
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.