alibaba/GraphScope

enhance `gsctl` command by implementing sub-command `install-deps`

Open

#2,883 opened on Jun 14, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (2,401 stars) (301 forks)batch import
component:pythongood first issue

Description

Task as titled. It is migrating, rather than implementing.

Background: we are refactoring the existing command-line utility gs written in bash (with framework bashly), to Python-based gsctl with package click. A bootstrap is built here, some subcommands are still missing.

More specifically, for this task, we have it in gs before, the logic for install-deps are implemented in a bash here:

https://github.com/GraphScope/cli/blob/main/src/install_deps_command.sh (Ask Wang to grant if you do not have the authorization.)

In this task, please DO NOT reimplement it, but reuse this bash with minor revision:

  1. fulfill the subcommand install-deps in here, and migrate the existing options here (L119-L168)
  2. put install_deps_command.sh to https://github.com/alibaba/GraphScope/tree/main/python/graphscope/gsctl/scripts
  3. parse and process the options with click in gsctl.py , (refer to sub-command make), and invoke the install_deps_command.sh, please be aware that some minor revisions may in need in the .sh to process the parsing args.
  4. make it works.

Contributor guide

Tech stack
pythonshell
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonbashclickGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Locate the existing install deps command.sh in the GraphScope/cli repository (need authorization). Study the existing gsctl.py at python/graphscope/gsctl/gsctl.py, especially the 'make' subcommand for reference. Implement the install deps subcommand using click, parse options from bashly.yml, and invoke the shell script with proper arguments.