a9787dd2d1
* start papermill rollback * move reports to templates folder * comment some stuff * refactor reports controller * change var names * clean ctrl class vars * small refactoring on metadata search * relocate some func * breaking changes * revert some changes * destroying changes * change menu appearance * change menu appeaerance again * update choices * change some assets locations * remove unused vars * change some docstrings * rename vars * its working * forgot one dash * omg its working * clean some code and doc * change func name * fix a bug and add some comments * fix economy report startup * add custom reports * allow custom reports * forgot to delete this * unused import * make somestuff more explicit, 5 min rule * add helper func * supress errors--no-verify * add some type checks * fix check ipynb func * check inputs in run * rewrite some integration tests * remove unused import * add some docs to website * add auto completion * warn if no forecast * add to do * add arg name if 1 arg * add papermill pointing to github main * add notebooks * fix terminal spec * relocated choices files * merge main * relocate website docs for reports * limit user choices * fix portfolio auto completion * limit choices fix * clean som edocstrings * limit user choices in run command * improve run parser * fix msg * add reports controller tests * relax crypto choices limit * contain commands * pass pre commit * flake8 * flake8 * ignore mypy * pylint * website * move docs to jupyter tab * add installer dep * remove etf * remove reports * update reports to main * handle events erros * rever reports to previous commits before main merge * add papermill installer strategies * add flags to terminal * avoid sdk crash * execute notebook in thread * remove unused sys * execute report in a child process * fix some notebook stuff * fix portfolio report * fix reports controller volatility * change api to sdk * move images * remove som unucessary installer imports * remove debugger warning * move ipykernel launcher * supress notebook crash * remove portfolio decorator * fix run command * forgot to change this * add images * fix portfolio report * fix crypto report * linting and tests * add run integration test * pylint * hide reports module args * try at supressing args * try at supreccing warning * solve some os issues * handle pm errors * fix warning unrecognized arguments * change comment * avoid crash when parameters not found * fix etf commands * minor cleanup * update forecasting check * fix some linting * fix futures test * pylint * limit user choices to prompt * limit user choices to prompt * supress warnings * revert poetry lock back to main * papermill pointing to main * flake8 * forgot requirements * Update helper_funcs.py * Update reports_model.py * choices Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: James Simmons <53658028+simmonsj330@users.noreply.github.com>
REPORTS
This menu has a different concept from remaining menus. It has 2 main goals:
- Generate a personalised report.
- Allow the user to write notes on that notebook (report), as if it was his personal investment diary.
How to create your own personal report
-
Copy one of the existing notebook reports as a template, e.g. dark_pool.ipynb.
-
Rename that notebook with a name that reflects what you want this notebook to contain, even including your name.
-
One of the notebook cells will have a
parameterstag, that's where the papermill will parametrize the notebook. Thus, your variables should be declared there. -
Remove the function calls that you don't care about to build your own report.
-
When building your template notebook, there are 2 type of possible things you can do:
- Create a markdown cell, where you can add a title or a description. E.g.
## Analyst Targets- Create a code cell, where you should both: import a module, and call a function to display a chart or print data. E.g.
from openbb_terminal.stocks.due_diligence import finviz_view finviz_view.analyst(ticker=ticker, export='')
Note: In order to find the name of the function you want, you should either crawl through the codebase (and ask help in discord) or look into our readthedocs (#TODO).
How to run the report
-
In config_terminal you may need to change your
PAPERMILL_NOTEBOOK_REPORT_PORTfrom8888. If the notebook generation fails, it is likely that the port selected is not the correct one. -
Start the terminal with
python terminal.py -
Select
reportscontext, and choose from the options selected - which are derived from the .ipynb jupyter notebook files on the reports folder. -
This should prompt you with a filled notebook with name:
<date time>_<report name>_<args>.ipynb. E.g.20210725_193517_dark_pool_AMC.ipynb -
Due to the last cell of the notebook, the report is saved by default as
.html. E.g.20210725_193517_dark_pool_AMC.htmlfolder = "notebooks/reports/" extension = ".ipynb" !jupyter nbconvert {report_name} --to html --no-input -
You can now write your own personal notes on the notebook. By doing:
- Click on the notebook cell that you are interested in writing your notes
- On the toolbar click on "+" to add a new cell
- On the toolbar click on "Cell" -> "Cell Type" -> "Markdown"
- You're now ready to write your own notes
-
Once you're happy with your report, you can either:
- Re-run the last cell, potentially changing output from
.html: - Or, on the toolbar click on "File" -> "Download as" -> Select your preferred option (e.g. HTML)
- Re-run the last cell, potentially changing output from