Commit Graph

25 Commits

Author SHA1 Message Date
Danglewood
757fc57174 docs/fix-urls: Updates the Terminal About URLs to match /develop (#5720)
* update Terminal about URLs and some other broken links

* ruff

* intro

* changing the heading levels

* dependency management sections

* structure

* developer guides

* structure

* contributor guides

* keywords and descriptions

* broken urls

* cool cards

* Cool cards (#5727)

* tidy up terminal/content

* some more tidy up

* fix styling for platform that was missing

* more tidy up

* improve color for dark and light mode

* create new reference card for more basic cards

* rename back to menus

* implement all index.md for terminal, except reference

* improve bot title

* more refactoring

* fix remaining index

* header styling

* more styling

* heheheheheheeh

* Revert "heheheheheheeh"

This reverts commit 7d095fcfd2.

* Ccards (#5733)

* links

* more links

* improved styling and chevron aligned to title

* fix index.mdx urls for Terminal

* update package.json

* update index.mdx

* fix generation

* spelling

* toolkit_extensions

* update data extensions

* couple of links

* add tiingo to data extensions list

---------

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-11-16 17:02:59 -05:00
DidierRLopes
4ad995fdd0 Docs/terminalpro and improvement (#5622)
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00
James Maslek
006943d5c9 Merge pull request #5391 from OpenBB-finance/release/3.2.2
Release/3.2.2
2023-08-30 09:50:38 -04:00
MarkBenjamin
df9af48d6d Feature/sdk usage basics webpage tidy (#5388)
* tidy sdk usage webpage

* revert potentially unnecessary changes

---------

Co-authored-by: mark <MarkBenjamin1@gatech.edu>
2023-08-29 20:18:25 +00:00
James Maslek
f890eec7b3 Merge branch 'main' into release/3.2.2 2023-08-29 10:46:35 -04:00
dio
db9d462188 Feature/companies house (#4721)
* Addition of UK Companies House data. Allows you to search for companies and inspect their details and download any filings including accounts

* reformatting of code

* reformatting

* reformat code

* reformat

* fix codespell issue

* updated for changes in way key are handled

* small reformatting

* added timeout for requests

* formatting

* ruff order fixes

* black reformatting

* merge issue - removed function call_openbb

* black format change

* Added new Companies House functionality to SDK

* formattng

* more Formatting (black)

* Ruff fix

* change return type for function

* forced type conversion

* return type fix

* correct error return type

* fix return type

* deleted companieshouse tests as they require API key

* Extra validation added for when data not exist from remote calls

* Added extra commands to en.yml

* spelling mistake correction

* fat finger trouble corrected

* Save documents with identifying names and allow documents to be viewed directly within OpenBB

* ruff updates

* black changes

* ruff change

* Addition of currently loaded company information in menu

* add entry in the API keys guide for Companies Hosue

* adds images to api keys guide

* adds section in SDK API Keys Guide for Companies House

* test file for companieshouse_model

* changed test data due to ruff line size limit

* resolve merge issues

* resolve merge issue

* doc strings examples

* added docstrings for companieshouse_model

* allow download_filking_document methid in view class to be called from SDK

* added docstring for download_filing_document SDK method

* correct Companies house key literal

* replace starnge . with ,

* add check_api_key decorator to each methopd in controller

* implement next and previous for looping through filings

* ruff changes

* correct tests

* companing filings now allows you specify category

* ruff line length issue resolved

* retrieves all filings  and  added charges command

* bug fix

* Added limit parameter to filings command, def :100

* fix ruff issue

* added get_charges to sdk and to test class

* resolved ruff line length issue

* add some view tests

* add some controller tests

* applying fix not merged to develop yet, column_keep_types=['Company Number']

* fix i18n description

* update test_print_help

* actually update test_print_help.txt

* Update en.yml - no colon

* rerorder imports - ruff failurre

* simple text change

* ruff fix

* help text change trying to fix pytest issue

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-08-28 14:28:33 +00:00
Danglewood
6ddb3b96dd Fix URL in SDK Stock Screener Intro
Fixes the URL pointing to the OpenBBUserData folder guide.
2023-08-21 15:56:26 -07:00
Colin Delahunty
3147577fc9 bye bye shroom (#5351)
* bye bye shroom

* missed one

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-08-21 21:26:03 +00:00
Danglewood
f1eee44cab Feature/options_views: Add a Variety of Views/Charts to Extend the OptionsChains Class (#5222)
* add options_chains_view

* vsurf charts

* skew for strike vs contract

* doc string

* add chart_volatility

* linting

* codespell

* mypy

* types

* tmx mypy

* update test file

* add synthetic long/short to strategies

* updates test_options_chains_model.py

* updates some docstrings

* update documentation

* actually commit the documentation page

* update documentation screenshots

* try catch for 403 error

* add tests for options_chains_view

* int64

* SPX error handling

* add cboe options dashboard for terminal

* codespell

* enable mouse scroll wheel zoom for charts

* declare key values for all widgets

* add some more streamlit charts and tables

* fix test_yfinance_view.py

* conflict resolution

* test

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-08-03 20:58:47 +00:00
Danglewood
3af4be30c9 fix headTitle (#5253) 2023-07-25 18:03:45 +00:00
Danglewood
8df31f8de4 feature/usd-liquidity-index: Adds USD Liquidity Index to Economy menu (#5174)
* add USD Liquidity Index to Economy menu

* mypy

* add screenshots to Terminal Economy Intro

* add test to test_fred_model

* add Broad US Dollar Index to list of comparables

* docs pages update

* fix test_nasdaq_model

* ask obb indexing

* return just the calculated series by default

* a grid for Squares

* raw table output

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: martinb-bb <105685594+martinb-bb@users.noreply.github.com>
2023-07-06 15:50:10 +00:00
Danglewood
0af2025b71 fix example (#5196) 2023-07-05 13:22:56 +00:00
Danglewood
42bf98d6a4 hotfix/options-chains-guide: Adds SDK intro guide for Options Chains (#5155)
* add SDK intro guide for options chains

* add screenshots to page
2023-06-20 12:52:52 +00:00
Danglewood
e202aeb557 Hotfix/docs-sdk-basics: Updates SDK basics page. (#5024)
* updates SDK basics guide - images to follow

* adds images

* spelling

* add sentence for token regeneration

* consolidates changing sources page with the basics page

* consolidate chart-stylying guide with basics

* api-keys pages

* adds Stocks Insiders intro to SDK docs

* typo

* add cloud installation

* syntax error

* no cloud installation instructions

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-23 20:20:29 +00:00
Danglewood
72c4ce01f3 Updates SDK Intro Guide for Fundamental Analysis Module's Recent Changes (#4964)
* Updates SDK intro guide for fundamental analysis for recent changes

* previous commit was missing this

* fixes

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-04 17:32:27 +00:00
northern-64bit
5e92dbe636 Fix error in the SDK portfolio intro documentation (#4945) 2023-05-01 20:41:23 +00:00
Theodore Aptekarev
18204202ac Remove stocks/disc/cnews command (#4920)
* Remove stocks/disc/cnews command from terminal and sdk

* Remove disc/cnews tests and test data

* Remove cnews from default sources, translations and intros

* Remove old test data files that are not used anymore

* Add pydocstyle ignore statement to pyproject toml

* Fix print help in stocks/disc controller test
2023-04-27 16:24:13 +00:00
Jerry Duluk
f21d25436b Improved SEO of OpenBB Docs (#4774)
* Small typo

* Updated SEO for OpenBB Bot Docs

* Updated SEO for all SDK docs pages

* Updated all SEO for OpenBB Terminal Docs pages. Plus grammar edits

* Updated spelling edits for SDK and Terminal

* fix: headtitle component

* Updated Page titles for SDK and Terminal FAQ pages

* Updated page titles for all SDK docs pages

* Updated page titles for all Terminal Docs Pages (not reference pages)

* Updated page titles for Bot (not reference pages)

* Add | OpenBB Docs title for SDK and Terminal (#4883)

* add Terminal | OpenBB Docs

* SDK | OpenBB Docs added

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2023-04-25 13:58:58 +00:00
Danglewood
af800613c8 Hotfix/docs - Some Intros Updates. (#4777)
* removes .ini from screener preset examples

* updates sdk economy intro

* Update economy intro guide screenshot

Swaps screenshot with new chart

* updates terminal stocks intro

* updates screenshots for stocks intro
2023-04-14 07:34:09 +00:00
martinb-bb
8397a990c9 URL(404) fixes for multiple locations (#4738)
* URL fixes

* docker url
2023-04-11 18:06:49 +00:00
Danglewood
8b30f1a117 Hotfix/stock screener - Stock Screener Fixes (#4674)
* stock screener fixes

* improves error message, this is a FinViz preset

* removes non-screener functions from screener menu

* ruff

* removes tests for removed non-screener functions

* updates tests

* black

* ruff

* adds s&p 500 sector presets

* updates Terminal intro guide for stock screener

* Update screener.md

Updates guide with screenshots.

* Update screener.md

spelling

* updates SDK Intro Guide for Stock Screener

* pylint disable=too-many-lines --> disable=C0302

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2023-04-08 20:19:04 +00:00
DidierRLopes
2754be2620 Improve overall docusaurus (#4675)
* Improve overall docusaurus

* update pypi on installation

* fix merge conflicts

* fix spelling

* change CRLF to LF

* improve docs installation for bot

* more changes

* few more

* fix

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-04-07 01:50:45 +00:00
James Maslek
69694332e6 Documentation push (#4501)
* hi didier

* Add files

* Add the changelogs from GH

* Api keys + cleaning up spelling + found some old refs

* spelling

* Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0

* updates to faq sections

* spelling

* fixing FA so it runs

* adding guides - need pics

* telegram/discord docs markdown format conversion

* fix: added new reference styles

* adding examples to discord - remove play button

* updating bot docs

* image showing on docs

Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>

* feat: added imageurl for examples

* updates Stocks SDK intro

* bot pics update

* updating rest of bot docs

* adding code for generating index and bot updates

* linting

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* add some updates to guide for auto select commands

* Add pytest-recorder to requirements.txt

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2023-03-23 17:36:47 +00:00
jose-donato
6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* feat: adds bot docs to docu

* fix: file structure

* fix: brings changelog and switch platform button

* adding available options and changing Example text

* fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component

* fix: updated readme to reflect new changes

* fix: made it so from iframe only shows relevant sidebar

* PLAY BUTTON WOOO - works on discord/charting/chart

* comment

* fix: search bar, improve search

* fix: hijacks ctrl+k from iframe, adds visit to hub link

* about

* setting up play button for all images on Discord

* Bot docs updates

* terminal/faqs

* update main page

* add changelog to terminal

* SDK refactoring

* minor reordering

* bot struct in place

* move bot faqs over

* updating bot index and installation

* add new letterings

* fix: adds new navbar

* fix: new bot images and layouts

* updating installation and flow

* black linter

* spelling

* spelling

* The best commit

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-16 16:29:57 +00:00
Jeroen Bouma
452ecd1275 Make adjustments to the guides (#4477)
* Update the website guides

* Fix wrong paths in about functionality

* Update settings and feature flags menu

* Done

* Done

* Update screen
2023-03-14 20:07:35 +00:00