diff --git a/README.md b/README.md index 33f9961b4a3e..6ef2f078d59f 100644 --- a/README.md +++ b/README.md @@ -100,17 +100,84 @@ That's it.

Table of Contents

    -
  1. Installation
  2. -
  3. Contributing
  4. -
  5. License
  6. -
  7. Disclaimer
  8. -
  9. Contacts
  10. -
  11. Star History
  12. -
  13. Contributors
  14. +
  15. Quick Start
  16. +
  17. Installation
  18. +
  19. Contributing
  20. +
  21. License
  22. +
  23. Disclaimer
  24. +
  25. Contacts
  26. +
  27. Star History
  28. +
  29. Contributors
-## 1. Installation +## 1. Quick Start + +### Python Package + +Install OpenBB from PyPI and start querying financial data in seconds: + +```bash +pip install openbb +``` + +```python +from openbb import obb + +# Fetch historical price data for Apple +output = obb.equity.price.historical("AAPL") +df = output.to_dataframe() +print(df.tail()) +``` + +### REST API + +Run a local REST API server to access OpenBB data from any language or application: + +```bash +pip install "openbb[all]" +openbb-api +``` + +The server starts at `http://127.0.0.1:6900`. Open that URL in your browser to verify it is running. +Interactive API documentation is available at `http://127.0.0.1:6900/docs`. + +### Development Setup (Running from Source) + +To run and develop OpenBB directly from the source code: + +1. **Prerequisites**: Git, Python 3.10–3.13, and a virtual environment with `poetry` installed. + + ```bash + pip install poetry + ``` + +2. **Clone the repository**: + + ```bash + git clone https://github.com/OpenBB-finance/OpenBB.git + cd OpenBB + ``` + +3. **Install all packages in editable mode**: + + ```bash + cd openbb_platform + python dev_install.py -e + ``` + +4. **Verify the installation**: + + ```python + from openbb import obb + print(obb.coverage.providers) + ``` + +For a full walkthrough see the [Developer Documentation](https://docs.openbb.co/python/developer). + +--- + +## 2. Installation The ODP Python Package can be installed from [PyPI package](https://pypi.org/project/openbb/) by running `pip install openbb` @@ -128,7 +195,7 @@ or by cloning the repository directly with `git clone https://github.com/OpenBB Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/cli/installation). -## 2. Contributing +## 3. Contributing There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️) @@ -148,12 +215,12 @@ Before creating a ticket make sure the one you are creating doesn't exist alread 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 +## 4. License Distributed under the AGPLv3 License. See [LICENSE](https://github.com/OpenBB-finance/OpenBB/blob/main/LICENSE) for more information. -## 4. Disclaimer +## 5. 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. @@ -168,7 +235,7 @@ All names, logos, and brands of third parties that may be referenced in our site 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 +## 6. Contacts If you have any questions about the platform or anything OpenBB, feel free to email us at `support@openbb.co` @@ -176,7 +243,7 @@ If you want to say hi, or are interested in partnering with us, feel free to rea Any of our social media platforms: [openbb.co/links](https://openbb.co/links) -## 6. Star History +## 7. Star History This is a proxy of our growth and that we are just getting started. @@ -184,7 +251,7 @@ But for more metrics important to us check [openbb.co/open](https://openbb.co/op [![Star History Chart](https://api.star-history.com/svg?repos=openbb-finance/OpenBB&type=Date&theme=dark)](https://api.star-history.com/svg?repos=openbb-finance/OpenBB&type=Date&theme=dark) -## 7. Contributors +## 8. 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.