jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docker : building + publishing (#2904)

Browse Source 
* fixed integrated test test_stocks_ba.openbb

* fixed integrated test test_stocks_dd.openbb

* improved and centralised the check

* fix lint

* Docker : update ci + build files

* Docker : update build and CD

* Docker : update CD

* Docker : test

* Docker : test CD

* Docker : test CD

* Docker : rename `build.sh`

* Docker : tests CD

* Docker : test CD

* Docker : update CD + build

* Docker : fix CD

* Docker : fix CD

* Docker : build

* Docker : test CD

* Docker : CD

* Docker : CD

* Docker : test

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : build + CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : test CD

* Docker : build

* Docker : test CD

* Docker : build + cd

* Moving `scripts`

* Checkout `helper_funcs.py` from main

* Docker : remove test file with alpine

* fixing readme errors

* fixing missed readme errors

* Docker : build

* Logging : handle docker app name

* Docker : test CD

* Docker : cd

* Doc

* Doc

* Doc : linting

* Doc

* Docker

* Doc

* Fixing `terminal_controller`

* Linting

* Doc : fixing links

* Version 1.9.1

* Docker : fix name

* Doc : add volumes in command

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: James Simmons <simmonsj330@gmail.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
This commit is contained in:
Chavithra
2022-10-19 18:00:59 +02:00
committed by GitHub
parent 6fa85372c6
commit eb244a1d8d
23 changed files with 391 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
README.md vendored
View File

@@ -66,44 +66,48 @@
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
<li> <a href="#about-the-project">About The Project</a> </li>
<li><a href="#installation">Installation</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#disclaimer">Disclaimer</a></li>
<li><a href="#contacts">Contacts</a></li>
<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>
</ol>
</details>
## About The Project
## 1. About The Project
**How it started:**
OpenBB Terminal 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 💎🙌.
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:**
OpenBB Terminal provides a modern Python-based integrated environment for investment research, that allows
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 modern Python-based environment, OpenBBTerminal opens access to numerous Python data libraries in Data Science
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).
## Installation
## 2. Installation
If you wish to install the Terminal, there are currently four options:
If you wish to install the OpenBBTerminal, there are currently four options:
- [Using the Installer](https://openbb-finance.github.io/OpenBBTerminal/#accessing-the-openbb-terminal) (recommended if you just want to use the terminal)
- [Using Python](openbb_terminal/README.md#anaconda--python) (recommended if you want to develop new features)
- [Using Docker](openbb_terminal/README.md#Docker-Installation) (alternative option to the installer if preferred)
|**Option**|**Use case**|
|:-|:-|
|[Installer for Mac or Windows](https://openbb-finance.github.io/OpenBBTerminal/#accessing-the-openbb-terminal)|Recommended way if you just want to use the terminal.|
|[Git clone](openbb_terminal/README.md#anaconda--python)|Best way if you want to contribute to the project : by adding code or documentation.|
|[Pypi.org](openbb_terminal/SDK_README)|Best way if you want to use the SDK.|
|[Using Docker](openbb_terminal/DOCKER_README.md)|An alternative way.|
## Contributing
## 3. Contributing
There are 3 main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️)
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`)
@@ -115,33 +119,37 @@ There are 3 main ways of contributing to this project. (Hopefully you have starr
You can read more details about adding a feature in our [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md).
**Raise an issue or Request a feature**
**RAISE AN ISSUE OR REQUEST A FEATURE**
- 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).
**Join us**
**JOIN US**
Join [our Discord](https://openbb.co/discord) and provide us any feedback on The OpenBB Terminal.
## License
## 4. License
Distributed under the MIT License. See
[LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE) for more information.
## Disclaimer
## 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
*"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
```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. 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 OpenBB terminal
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.
amount, and may not be suitable for all investors.
## Contacts
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
@@ -153,11 +161,11 @@ Feel free to share loss porn, memes or any questions at:
- Discord: [openbb.co/discord](https://openbb.co/discord)
- Reddit: [openbb.co/reddit](https://openbb.co/reddit)
## Star History
## 7. Star History
[![Star History Chart](https://api.star-history.com/svg?repos=openbb-finance/OpenBBTerminal&type=Date)](https://star-history.com/#openbb-finance/OpenBBTerminal&Date)
## Contributors
## 8. Contributors
<a href="https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=OpenBB-finance/OpenBBTerminal" width="800"/>