mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
171 lines
9.5 KiB
Markdown
Vendored
171 lines
9.5 KiB
Markdown
Vendored
<!-- PROJECT SHIELDS -->
|
|
<!--
|
|
*** I'm using markdown "reference style" links for readability.
|
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
*** See the bottom of this document for the declaration of the reference variables
|
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
-->
|
|
|
|
[![Stargazers][stars-shield]][stars-url]
|
|
[![Forks][forks-shield]][forks-url]
|
|
[![Contributors][contributors-shield]][contributors-url]
|
|
[![MIT License][license-shield]][license-url]
|
|
|
|
[![Issues][issues-shield]][issues-url]
|
|
[![Bugs Open][bugs-open-shield]][bugs-open-url]
|
|
[![Bugs Closed][bugs-closed-shield]][bugs-closed-url]
|
|
|
|
[](https://github.com/OpenBB-finance/OpenBBTerminal/releases)
|
|
[](https://github.com/psf/black)
|
|
[](https://www.tickgit.com/browse?repo=github.com/OpenBB-finance/OpenBBTerminal&branch=main)
|
|
|
|
|
|
[](https://twitter.com/openbb_finance)
|
|
|
|
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBBTerminal)
|
|
|
|
[](https://codespaces.new/OpenBB-finance/OpenBBTerminal)
|
|
|
|
<!-- PROJECT LOGO -->
|
|
|
|
| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
|
|
|:--:|
|
|
| [](https://openbb.co) |
|
|
| Check our website at [openbb.co](https://openbb.co) |
|
|
|
|
<br />
|
|
|
|
<p align="center">
|
|
<h3 align="center">OpenBB Terminal 🚀</h3>
|
|
<h4 align="center">Documentation can be found at: https://openbb.co/docs </h4>
|
|
<p align="center">Click on the GIF below for a DEMO of the terminal.</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.youtube.com/watch?v=fqGPK8OVHLk" rel="OpenBB Terminal Demo">
|
|
<img src="images/openbb_terminal_illustration.gif" alt="OpenBB Terminal Illustration" width="100%"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://docs.openbb.co/terminal/installation"><strong>≪ GETTING STARTED</strong></a>
|
|
  ·   <a href="https://github.com/OpenBB-finance/OpenBBTerminal/tree/master/CONTRIBUTING.md"><strong>CONTRIBUTING</strong></a>   ·  
|
|
<a href="https://docs.openbb.co/terminal">
|
|
<strong>SEE FEATURES »</strong></a>
|
|
</p>
|
|
</p>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details closed="closed">
|
|
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
|
|
<ol>
|
|
<li><a href="#1-installation">Installation</a></li>
|
|
<li><a href="#2-contributing">Contributing</a></li>
|
|
<li><a href="#3-license">License</a></li>
|
|
<li><a href="#4-disclaimer">Disclaimer</a></li>
|
|
<li><a href="#5-contacts">Contacts</a></li>
|
|
<li><a href="#6-star-history">Star History</a></li>
|
|
<li><a href="#7-contributors">Contributors</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
## 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](https://docs.openbb.co/terminal/installation/windows)|Recommended way for Windows if you just want to use the OpenBB Terminal|
|
|
|[MacOS Installer](https://docs.openbb.co/terminal/installation/macos)|Recommended way for MacOS if you just want to use the OpenBB Terminal|
|
|
|[Source](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal|
|
|
|[Docker](https://docs.openbb.co/terminal/installation/docker)|An alternative way if you just want to use the OpenBB Terminal|
|
|
|
|
|**OpenBB SDK** |**Usage**|
|
|
|:-|:-|
|
|
|[PyPI](https://docs.openbb.co/terminal/installation/pypi)|If you wish to use the OpenBB SDK in Python or Jupyter Notebooks|
|
|
|[Source](https://docs.openbb.co/terminal/installation/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](/CONTRIBUTING.md).
|
|
|
|
### Create a GitHub ticket
|
|
|
|
Before creating a ticket make sure the one you are creating doesn't exist already [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues)
|
|
|
|
* [Report bug](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D)
|
|
* [Suggest improvement](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D)
|
|
* [Request a feature](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D)
|
|
|
|
### Provide feedback
|
|
|
|
We are most active on [our Discord](https://openbb.co/discord), but feel free to reach out to us in any of [our social media](https://openbb.co/links) for feedback.
|
|
|
|
## 3. License
|
|
|
|
Distributed under the MIT License. See
|
|
[LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/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](https://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](https://openbb.co/open).
|
|
|
|
[](https://star-history.com/#openbb-finance/OpenBBTerminal&Date)
|
|
|
|
## 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.
|
|
|
|
<a href="https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors">
|
|
<img src="https://contributors-img.web.app/image?repo=OpenBB-finance/OpenBBTerminal" width="800"/>
|
|
</a>
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
|
|
[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
|
[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors
|
|
[forks-shield]: https://img.shields.io/github/forks/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
|
[forks-url]: https://github.com/OpenBB-finance/OpenBBTerminal/network/members
|
|
[stars-shield]: https://img.shields.io/github/stars/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
|
[stars-url]: https://github.com/OpenBB-finance/OpenBBTerminal/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge&color=blue
|
|
[issues-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues
|
|
[bugs-open-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=yellow
|
|
[bugs-open-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen
|
|
[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success
|
|
[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed
|
|
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
|
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt
|
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
|
[linkedin-url]: https://linkedin.com/in/DidierRLopes
|