X-lab2017 / open-digger

Open source analysis tools
https://open-digger.cn
Apache License 2.0
281 stars 79 forks source link

fix: supplement and organize the dependency and readme files for each kernel #1589

Closed birdflyi closed 2 weeks ago

birdflyi commented 3 weeks ago

Fix https://github.com/X-lab2017/open-digger/issues/1578

Purpose

Supplement and organize the dependency requirements.txt files and README.md files for each kernel; Unified the startup method of all kernels.

Method

Feature

Kernels

kernel_name kernel_src_dir kernel_requirements kernel_readme kernel_build_run kernel_base_img
node.js "./src" "./package.json"->"dependencies" "./sample_data/README.md" "./package.json" "./package.json"->"scripts"."notebook"->"docker pull {kernel_base_img}"
python "./python" "./python/requirements.txt" "./python/README.md" docker command "continuumio/miniconda3"
python_v2 "./python_v2" "./python_v2/requirements.txt" "./python_v2/README.md" docker command "continuumio/miniconda3"
pycjs "./pycjs" "./pycjs/requirements.txt" "./pycjs/README.md" "./package.json" "./package.json"->"scripts"."notebook"->"docker pull {kernel_base_img}"

Results:

Extra: Fixed some minor bugs in notebook/node_vm2_pycaller.ipynb, python_v2/db/clickhouse_wrapper.py and python/db/clickhouse.py. The package.json settings makes the startup of kernel pycjs as easy as the kernel node.js. The startup method of kernel pycjs:

  1. Enter the root workdir: cd open-digger
  2. Build js environment(execute only on the first run): npm install
  3. Build docker image and run a container: npm run notebook-pycjs
frank-zsy commented 2 weeks ago

I am not quite familiar with Python kernel, can you check on this PR? @Peng99999

Peng99999 commented 2 weeks ago

@frank-zsy I've already tested it, and this PR can be merged. Thanks to @birdflyi for this work, the issue #1580 mentioned in the previous weekly meeting have been resolved. 👍