Option library have goal to assist implement in code base concepts of using options.
Install all dependecies for dev and test by
poetry install --with etl,dev,test
Easiest way to check haw to use option_lib is open Jupyter Notebook files in demo folder on your Google Collab.
- Open Google Collab
- Click to
File/Open
menu item. - On
Open notebook
popup window select GitHub and enter to an input fieldEnter a Github URL or search by organization or user
link to current repository https://github.com/akumidv/option_lib.git - Verify that in Repository dropdown selected
option_lib
- On table below will be showed list of Jupyter Notebooks
- Select anyone, for example
- Click to icon next to name
Open ... in new tab
For example https://github.com/akumidv/option_lib/blob/main/demo/Options%20for%20Smart%20Investor.ipynb
Easiest way to get data Example is load sample from shared Google drive folder.
Save them in data folder and set path to it in DATA_PATH
environment.
Also, you can see Jupyter Notebooks demo
- they have bash with gdrive
implementation how download data.
Go to the docs folder by cd ./docs
and run (be sure you have node.js installed on your PC)
npm install
npm run dev
Open link that will be shown in console
In future plans if there will be some useful code and docs to deploy with Vercel or Netlify.
Now docs are almost empty.