diff --git a/README.md b/README.md
index 8c9170ac86c..d4618e4c529 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,44 @@
-
-
-
-[![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)
-
-
-
-| 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) |
-
+
+
+
+
+[](https://twitter.com/openbb_finance)
+[](https://github.com/OpenBB-finance/OpenBBTerminal/releases)
+
+[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBBTerminal)
+
+
+
+
+OpenBB is committed to building the future of investment research by focusing on an open-source infrastructure accessible to everyone, everywhere.
+
-
Click on the GIF below for a DEMO of the terminal.
Click on the GIF above for a DEMO
- ≪ GETTING STARTED -   ·   CONTRIBUTING   ·   + + ≪ GETTING STARTED + +   ·   + + CONTRIBUTING + +   ·   + + DOCUMENTATION + +   ·   - SEE FEATURES » + SEE FEATURES » +
diff --git a/images/openbb-logo-dark.svg b/images/openbb-logo-dark.svg new file mode 100644 index 00000000000..75bcef259e1 --- /dev/null +++ b/images/openbb-logo-dark.svg @@ -0,0 +1,17 @@ + diff --git a/images/openbb-logo-light.svg b/images/openbb-logo-light.svg new file mode 100644 index 00000000000..f9c341f7428 --- /dev/null +++ b/images/openbb-logo-light.svg @@ -0,0 +1,17 @@ + diff --git a/website/content/sdk/usage/basics/index.md b/website/content/sdk/usage/basics/index.md index 87c25e50c26..cdd3b1019ef 100644 --- a/website/content/sdk/usage/basics/index.md +++ b/website/content/sdk/usage/basics/index.md @@ -28,7 +28,7 @@ The `obb` virtual environment has both `python` and `ipython` as methods for sta If this doesn't work, there may be an obvious reason why. - The installation was not completed. -- The terminal being used is different than the one which was used for installation. For example, Miniconda was installed using `CMD.exe` or `Anaconda Prompt`, but the current terminal is PowerShell. +- The terminal being used is different from the one which was used for installation. For example, Miniconda was installed using `CMD.exe` or `Anaconda Prompt`, but the current terminal is PowerShell. Open the same terminal used for installation and activate the `obb` environment, then enter: @@ -134,19 +134,19 @@ from openbb_terminal.sdk import openbb ## Navigation -The layout of the OpenBB SDK is similar to the menus in the OpenBB Terminal, with each one represented as a module. Instead of a `/` in the path, it is `.`. For example, `openbb.stocks.gov` is the Government sub-module of `stocks`. +The layout of the OpenBB SDK is similar to the menus in the OpenBB Terminal, with each one represented as a module. Instead of a `/` in the path, it is `.`. For example, `openbb.stocks.gov` is the Government submodule of `stocks`.  The attributes for each module - and docstrings for a function - can also be printed directly to the screen, insert a question mark at the end of the string. -```python +```jupyterpython openbb.stocks.gov.contracts? ``` **Note**: For a regular `python` session, the syntax is: `help(openbb.stocks.gov.contracts)` -```python +``` Signature: openbb.stocks.gov.contracts(symbol: str, past_transaction_days: int = 10) -> pandas.core.frame.DataFrame Call signature: openbb.stocks.gov.contracts(*args: Any, **kwargs: Any) -> Any Type: get_contracts @@ -190,11 +190,11 @@ API keys can be imported to the session by logging in to an [OpenBB Hub account] Copy the generated token and enter as the value for the `token` parameter, ignoring the email and password fields. By default, the credentials will be forgotten when the SDK session is terminated. -```python +```jupyterpython openbb.login? ``` -```python +``` Signature: openbb.login( email: str = '', @@ -226,7 +226,7 @@ silent : bool Examples -------- >>> from openbb_terminal.sdk import openbb ->>> openbb.login(email="your_email", password="your_password") +>>> openbb.login(email="