-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Update README.md * Create pipy.md * Rename pipy.md to pypi.md * Update README.md * Update pyproject.toml * Update README.md * Update README.md --------- Co-authored-by: James Maslek <[email protected]>
- Loading branch information
1 parent
3747424
commit 2130dea
Showing
3 changed files
with
96 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,6 @@ | |
| [![Bugs Open][bugs-open-shield]][bugs-open-url] | ||
| [![Bugs Closed][bugs-closed-shield]][bugs-closed-url] | ||
|
|
||
| [](https://github.com/OpenBB-finance/OpenBBTerminal/actions) | ||
| [](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) | ||
|
|
@@ -25,73 +24,48 @@ | |
| [](https://twitter.com/openbb_finance) | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
|
|
||
| | 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](www.openbb.co) | | ||
|
|
||
| <br /> | ||
| <p align="center"> | ||
| <a href="https://openbb.co/"> | ||
| <img src="images/openbb_gradient.png" alt="Logo" width="1000"> | ||
| </a> | ||
|
|
||
| <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://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"> | ||
| Investment research for everyone. | ||
| <br /> | ||
| <a href="https://docs.openbb.co/terminal/quickstart/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> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D"> | ||
| Report Bug</a> | ||
| · | ||
| <a href="https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D"> | ||
| Suggest Improvement</a> | ||
| · | ||
| <a href="https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D"> | ||
| Request a Feature</a> | ||
| </p> | ||
| </p> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details open="open"> | ||
| <details closed="closed"> | ||
| <summary><h2 style="display: inline-block">Table of Contents</h2></summary> | ||
| <ol> | ||
| <li> <a href="#1-about-the-project">About The Project</a> </li> | ||
| <li><a href="#2-installation">Installation</a></li> | ||
| <li><a href="#3-contributing">Contributing</a></li> | ||
| <li><a href="#4-license">License</a></li> | ||
| <li><a href="#5-disclaimer">Disclaimer</a></li> | ||
| <li><a href="#6-contacts">Contacts</a></li> | ||
| <li><a href="#7-star-history">Star History</a></li> | ||
| <li><a href="#8-contributors">Contributors</a></li> | ||
| <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. 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 | ||
| ## 1. Installation | ||
|
|
||
| If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of the following options: | ||
|
|
||
|
|
@@ -107,42 +81,33 @@ If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of | |
| |[PyPi](https://docs.openbb.co/sdk/quickstart/installation)|Recommended way if you just want to use the OpenBB SDK| | ||
| |[Python](https://docs.openbb.co/terminal/quickstart/installation?tab=python)|If you wish to contribute to the development of the OpenBB SDK | | ||
|
|
||
| ## 3. Contributing | ||
| ## 2. Contributing | ||
|
|
||
| There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️) | ||
|
|
||
| **BECOME A CONTRIBUTOR** | ||
| ### Become a Contributor | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Install the pre-commit hooks by running: `pre-commit install` | ||
| Any time you commit a change, linters will be run automatically. On changes, you will have to re-commit | ||
| 4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 5. Push to your Branch (`git push origin feature/AmazingFeature`) | ||
| 6. Open a Pull Request | ||
| * More information on our [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md). | ||
|
|
||
| You can read more details about adding a feature in our [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md). | ||
| ### Create a GitHub ticket | ||
|
|
||
| **RAISE AN ISSUE OR REQUEST A FEATURE** | ||
| Before creating a ticket make sure the one you are creating doesn't exist already [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues) | ||
|
|
||
| - Raise an issue by opening a [bug ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues). | ||
| - Request a new feature through a [feature request ticket](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) | ||
|
|
||
| **JOIN US** | ||
| ### Provide feedback | ||
|
|
||
| Join [our Discord](https://openbb.co/discord) and provide us any feedback on The OpenBB Terminal. | ||
| 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. | ||
|
|
||
| ## 4. License | ||
| ## 3. License | ||
|
|
||
| Distributed under the MIT License. See | ||
| [LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/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 | ||
| ## 4. Disclaimer | ||
|
|
||
| ```text | ||
| 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. | ||
|
|
||
|
|
@@ -151,25 +116,27 @@ Before deciding to trade in a financial instrument you should be fully informed | |
| 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 | ||
| 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. | ||
|
|
||
| If you have any questions about the terminal or anything OpenBB, feel free to email us at [email protected] | ||
| ## 5. Contacts | ||
|
|
||
| If you want to say hi, or are interested in partnering with us, feel free to reach us at hello@openbb.co | ||
| If you have any questions about the terminal or anything OpenBB, feel free to email us at `support@openbb.co` | ||
|
|
||
| Feel free to share loss porn, memes or any questions at: | ||
| If you want to say hi, or are interested in partnering with us, feel free to reach us at `[email protected]` | ||
|
|
||
| - Twitter: [@openbb_finance](https://twitter.com/openbb_finance) | ||
| - Discord: [openbb.co/discord](https://openbb.co/discord) | ||
| - Reddit: [openbb.co/reddit](https://openbb.co/reddit) | ||
| Any of our social media platforms: [openbb.co/links](www.openbb.co/links) | ||
|
|
||
| ## 7. Star History | ||
| ## 6. Star History | ||
|
|
||
| This is a proxyy of our growth and that we are just getting started. But for more metrics important to us check [openbb.co/open](www.openbb.co/open). | ||
|
|
||
| [](https://star-history.com/#openbb-finance/OpenBBTerminal&Date) | ||
|
|
||
| ## 8. Contributors | ||
| ## 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"/> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| [](https://pepy.tech/project/openbb) | ||
| [](https://github.com/OpenBB-finance/OpenBBTerminal) | ||
|
|
||
| | OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. | | ||
| |:--:| | ||
| | <img width="1000" alt="Screenshot 2023-02-14 at 5 12 08 PM" src="https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png"> | | ||
| | Check our website at [openbb.co](www.openbb.co) | | ||
|
|
||
|
|
||
| ## OpenBB SDK Overview | ||
|
|
||
| OpenBB SDK provides a convenient way to access raw financial data from multiple data providers. This allows users to build custom financial dashboards and reports in minutes. | ||
|
|
||
| More information on this product can be found [here](https://openbb.co/products/sdk) | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| The command below provides access to the core functionalities behind the [OpenBB Terminal](https://openbb.co/products/terminal). | ||
|
|
||
| ```python | ||
| pip install openbb | ||
| ``` | ||
|
|
||
| If you wish to utilize our **Portfolio Optimization** or **Machine Learning / Artificial Intelligence** toolkits, please see instructions [here](https://docs.openbb.co/sdk/quickstart/installation). | ||
|
|
||
| ## Usage | ||
|
|
||
| Access our fully fledged financial SDK with a single line of python code. | ||
|
|
||
| ```python | ||
| from openbb_terminal.sdk import openbb | ||
| ``` | ||
|
|
||
| Everything you need to use the OpenBB SDK can be found on our [Official Documentation](https://docs.openbb.co/sdk). | ||
|
|
||
| Main uses cases can be seen below. | ||
| ___ | ||
|
|
||
| #### RAW FINANCIAL DATA AT YOUR FINGERTIPS | ||
|
|
||
| Access raw financial data from any data source that you are interested. The open source nature of this SDK makes it so that this is an ever-growing project and that everyone can contribute to. | ||
|
|
||
|  | ||
|
|
||
| #### GENERATE INSIGHTS 10X FASTER | ||
|
|
||
| For most of the functionalities, adding `_chart` to the function will allow you to visualize the output directly from a Jupyter Notebook. Not only speeding up the time it takes to create a plot for the data you are interested in, but making building custom reports much faster. | ||
|
|
||
| <img width="992" alt="Group 550" src="https://user-images.githubusercontent.com/25267873/218906112-b2272d43-11fc-4ec1-9a8f-b2d8e2ed7dc1.png"> |