QuantConnect / QuantConnect/lean-cli
Add option `--execute` to `lean research`
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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