417769c4cc
* hi didier * Add files * Include build deps and third-party binaries in conda env files * Add the changelogs from GH * Api keys + cleaning up spelling + found some old refs * spelling * Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0 * updates to faq sections * spelling * fixing FA so it runs * adding guides - need pics * Add gcc and maturin to build dependencies * telegram/discord docs markdown format conversion * Remove gcc from conda env files * Update install from source guide for terminal * fix: added new reference styles * adding examples to discord - remove play button * updating bot docs * Update SDK installation docs * Bump datetime package in lock file because current version was yanked * Update requirements txts * Remove rust tools from main conda env * Pin poetry to 1.4.0 because of a regression in 1.4.1 * Bump version of lightgbm to 3.3.5 * Address formatting and minor content comments * Advise all users to clean up conda artifacts with scripts * Add placeholder for pywry related docs * Update requirements.txt * Downgrade statsforecast to prevent pulling jupyter-dash * Add catboost to conda dependencies for windows install to work * Add charset-normalizer to conda deps because of a buggy windows build * Add xgboost to conda deps because of a buggy windows build * working!! * 3.8 and 3.9 xgboost * spelling * Point sdk install from source to terminal source install * image showing on docs Co-authored-by: jose-donato <jose-donato@users.noreply.github.com> * feat: added imageurl for examples * updates Stocks SDK intro * bot pics update * Bump python version on macOS CI builds * updating rest of bot docs * Move charset-normalizer to the pip section of environment yamls * Update mac CI workflows to use the correct cache * Move poetry to pip section of the conda yamls * Fix typo in file path * Fix direct_url.json files not being deleted on the CI * Fool reviewpad * Actually fool reviewpad * adding code for generating index and bot updates * linting * add commands for GTK on linux * Update deps after conflicts and CRLF line endings made it into develop * test bump down for matplotlib * codesign more dylibs * intel workflow * Add signing stuff that failed to intel * M1 file now * Remove duplicate lines from codesigning section of build instructions * Downgrade matplotlib to 3.7.0 to mitigate windows error * Downgrade python to 3.9 in attempt to fix scipy not packaging correctly * Downgrade python 3.9 to resolve conflicts found by conda * Remove duplicate xgboost references * Downgrade scikit-learn to avoid DistanceMetric32 not being found * Remove site-packages from bundle following python 3.10 -> 3.9 * Downgrade scikit-learn to avoid DistanceMetric32 not being found * Fix english in source installation * Revert advised python to 3.9 * Update SDK installation docs * Fix typo * Update lock file hash * Consolidate all installation instructions in the terminal section * Add --no-cache-dir to pip calls * Fool reviewpad * Remove reference of the conda cleanup from the pypi install * Fetch the environment yaml directly from the repo without downloading it * Add rosetta, cpp build tools and libomp as top level requirements * Update installation links in repo readme * adds brew install libomp to FAQ section * fix typo from my updatet * Capitalization of Section Headers * puts PyPi toolkit install in quotes, necessary for a non-bash shell. * grammar fixes * update docker windows instructions --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com> Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
9.1 KiB
Vendored
| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
|---|
 |
| Check our website at openbb.co |
OpenBB Terminal 🚀
Documentation can be found at: https://openbb.co/docs
Click on the GIF below for a DEMO of the terminal.
≪ GETTING STARTED · CONTRIBUTING · SEE FEATURES »
Table of Contents
1. 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 |
| Source | If you wish to contribute to the development of the OpenBB Terminal |
| Docker | An alternative way if you just want to use the OpenBB Terminal |
| OpenBB SDK | Usage |
|---|---|
| PyPI | If you wish to use the OpenBB SDK in Python or Jupyter Notebooks |
| Source | If you wish to contribute to the development of the OpenBB Terminal |
| nbsp; |
2. Contributing
There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️)
Become a Contributor
- More information on our CONTRIBUTING GUIDELINES.
Create a GitHub ticket
Before creating a ticket make sure the one you are creating doesn't exist already here
Provide feedback
We are most active on our Discord, but feel free to reach out to us in any of our social media for feedback.
3. License
Distributed under the MIT License. See LICENSE for more information.
4. Disclaimer
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.
All names, logos, and brands of third parties that may be referenced in our sites, products or documentation are trademarks of their respective owners. Unless otherwise specified, OpenBB and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Our use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.
5. 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
Any of our social media platforms: openbb.co/links
6. Star History
This is a proxy of our growth and that we are just getting started. But for more metrics important to us check openbb.co/open.
7. Contributors
OpenBB wouldn't be OpenBB without you. If we are going to disrupt financial industry, every contribution counts. Thank you for being part of this journey.