QuantConnect / QuantConnect/lean-cli

Add option `--execute` to `lean research`

Open
#133 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
326
Forks
168
Avg merge
3d 50m
Merged PRs (30d)
3

Description

It would be great if we could execute the cells of research.ipynb from the terminal using a command like
lean research <project> --execute.

Note, this feature is already available for Jupyter notebooks. You can run the command
jupyter nbconvert --to notebook --inplace --execute research.ipynb
or alternatively you can use papermill.

But it doesn't work that way in connection with Lean CLI as the notebook is running in a Docker container.

Bonus
Ability to execute cloud research notebooks, i.e. something like
lean cloud research <project> --execute.

Motivation
I use the research environment frequently to create customized reports/charts and this feature would be helpful to automate that process.

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 at the lean research <project> CLI entry point and review how research.ipynb runs inside the Docker container. Compare the requested behavior with jupyter nbconvert --to notebook --inplace --execute and papermill; done means local research notebooks execute through --execute, with cloud execution treated as the stated bonus scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, jupyter, python
Domain
cli, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.