49641bd9e8
* Remove undesired example files * Update the documentation for routines * Add in video * Add some additional text * Add in a routines example that can be activated with --example * Remove default old examples * Add portfolio example holdings file * Add portfolio optimization example allocation file * Add example files for the portfolio menus * Remove code that unintentionaly prints the home menu on every routine * Add home instead of / * Remove requirement to add file if you have an example * Ensure portfolio/po/params also talks about docs correctly * Move all routine, portfolio and screener presets to the correct folder * Remove presets since they are moved * Remove presets since they are moved * Same implementation as for file in po * Adjust code so it works with new folder * Adjust code so it works with new folder * Adjust code a little since I changed folder * Update screener documentation to include how to create a screener * Remove old readme * Update documentation to better reflect where to find the files * Also update SDK notes * Update exe with auto complete and more info * Add images * Update images and the last script * Update text to make it more apparent that it has an example attached * Add section for routine scripts on home menu * Make call_about more robust and add record and stop * Update the routine markdown with info about record/stop including video * Update scripts * Update portfolio report * Update tests and report * fix small load bug * rewrite help test * last fix was buggy * example by default * fix po integration test * keep example on arg * adapt integration test * fix portfolio integration test * fix more portfolio integration tests * pa is not an option anymore * portfolio report choices only holdings * update integration test for portfolio report * Small formatting improvements * Remove sleep and fix inconsistent return * Some spelling * oops * Fix tests --------- Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
OpenBB Terminal 🚀
Documentation can be found at: https://openbb.co/docs
Click on the GIF below for a DEMO of the terminal.
Investment research for everyone.
≪ GETTING STARTED
· CONTRIBUTING ·
SEE FEATURES »
Report Bug
·
Suggest Improvement
·
Request a Feature
Table of Contents
1. About The Project
How it started:
OpenBBTerminal is an awesome stock and crypto market terminal that has been developed for fun, while I saw my GME shares tanking. But hey, I like the stock 💎🙌.
How it's going:
OpenBBTerminal provides a Python-based integrated environment for investment research, that allows an average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies.
As a Python-based environment, OpenBBTerminal opens access to numerous Python data libraries in Data Science (Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Sklearn, Flair), and Data Acquisition (Beautiful Soup, and numerous third-party APIs).
2. Installation
If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of the following options:
| OpenBB Terminal | Usage |
|---|---|
| Windows Installer | Recommended way for Windows if you just want to use the OpenBB Terminal |
| MacOS Installer | Recommended way for MacOS if you just want to use the OpenBB Terminal |
| Docker | An alternative way if you just want to use the OpenBB Terminal |
| Python | If you wish to contribute to the development of the OpenBB Terminal |
| OpenBB SDK | Usage |
|---|---|
| PyPi | Recommended way if you just want to use the OpenBB SDK |
| Python | If you wish to contribute to the development of the OpenBB SDK |
3. Contributing
There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️)
BECOME A CONTRIBUTOR
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Install the pre-commit hooks by running:
pre-commit installAny time you commit a change, linters will be run automatically. On changes, you will have to re-commit - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to your Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
You can read more details about adding a feature in our CONTRIBUTING GUIDELINES.
RAISE AN ISSUE OR REQUEST A FEATURE
- Raise an issue by opening a bug ticket.
- Request a new feature through a feature request ticket.
JOIN US
Join our Discord and provide us any feedback on The OpenBB Terminal.
4. License
Distributed under the MIT License. See LICENSE for more information.
5. Disclaimer
"A few things I am not. I am not a cat. I am not an institutional investor, nor am I a hedge fund. I do not have clients and I do not provide personalized investment advice for fees or commissions." DFV
Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment
amount, and may not be suitable for all investors.
Before deciding to trade in a financial instrument you should be fully informed of the risks and costs associated with trading the financial markets, carefully consider your investment objectives, level of experience, and risk appetite, and seek professional advice where needed.
The data contained in the OpenBBTerminal is not necessarily accurate.
OpenBB and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.
6. Contacts
If you have any questions about the terminal or anything OpenBB, feel free to email us at support@openbb.co
If you want to say hi, or are interested in partnering with us, feel free to reach us at hello@openbb.co
Feel free to share loss porn, memes or any questions at:
- Twitter: @openbb_finance
- Discord: openbb.co/discord
- Reddit: openbb.co/reddit