Feature/news sentiment #4339

Sai-132 · 2023-02-27T10:28:40Z

Description

Newssentiment is a function that displays top news articles and associated sentiment for stock tickers provided by media aggregator Onclusive, through the alternative data platform Althub

newssentiment is in the main menu of your terminal
newssentiment/show is used to get the news articles and the associated sentiment

usage:

  [show, -t,--ticker, -sd, --start_date, -ed, --end_date, -d, --date, -l,--limit,-o,--offset, --export]
  
  These all are optional arguments:

  -t, --ticker [ TICKER ]
           Ticker to analyze (default: None)
  -sd, --start_date [ START DATE ]
           The starting date (format YYYY-MM-DD) to search articles from (default: False)
  -ed, --end_date [ END DATE ]
           The end date (format YYYY-MM-DD) to search articles up to (default: False)
  -d, --date [ DATE ]
           Show the article data on this day (format YYYY-MM-DD). (default: False)
           If you use the date argument start_date and end_date arguments will be ignored.
  -l, --limit [ LIMIT ]
           Number of articles to be displayed (default: 100)
  -o, --offset [ OFFSET ]
           The offset indicates the starting position of article records (default: 0)
  --export [ EXPORT ]
           Export raw data into csv, json, xlsx (default: )

  Note: if a date or a date range is not specified, articles from the last five business days are considered.

example:

  show -t AAPL -sd 2023-01-01 -ed 2023-01-30 -l 50 -o 200

How has this been tested?

Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration.

Make sure affected commands still run in terminal
Ensure the SDK still works
Check any related reports

Checklist:

I have adhered to the GitFlow naming convention and my branch name is in the format of feature/feature-name or hotfix/hotfix-name.
Update our documentation following these guidelines. Update any user guides that are affected by the changes.
Update our tests following these guidelines.
Make sure you are following our CONTRIBUTING guidelines.
If a feature was added make sure to add it to the corresponding integration test script.

Others

I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.

deeleeramone · 2023-02-28T01:32:57Z

Hey, thanks for the PR! A few notes on this:

This belongs in the Stocks menu because it is specific to Stocks.
This doesn't warrant its own sub-menu, it is one function, and is more suited to be in the Behavioural Analysis or Discovery sub-menus.
Arguments for Terminal functions (argparse) need to follow the convention: - for one letter only, -- for everything else. -s & --start_date, -e & --end_date.
The nested completer is not working for the function's arguments.
The name of the function does not correlate with what the function does. show is used as an argument elsewhere, a better handle for the function would be: ns, short for news_sentiment.
Naming needs to be followed. news_sentiment instead of NewsSentiment. onclusivedata_controller, etc. No capitals in the file names; OnclusiveData would be used as a class object name, and not a file or function.
The folder has no __init__.py file, nothing can be imported from the folder. This should be moved to a sub-menu anyways, the model and view files are the only ones which need to travel.
Most importantly, It does not appear to work.

Sai-132 · 2023-02-28T15:05:34Z

As per the instructions above, I have updated the folder structure and created ns (News Sentiment) files under the Discovery sub-menus.

To access Althub APIs, you just need to set the environment variable (OPENBB_ALTHUB_API_TOKEN).
In our previous email conversations, we sent an API_TOKEN. You can access our APIs using that token.

deeleeramone · 2023-02-28T16:42:20Z

This has not been added to the /keys menu, and instructions in the documentation pages need to be included for obtaining any API token.

To access Althub APIs, you just need to set the environment variable (OPENBB_ALTHUB_API_TOKEN).

Error when handling no key entered:

2023 Feb 28, 11:38 (🦋) /stocks/disc/ $ ns

OPENBB_ALTHUB_API_TOKEN not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu.
Error: 'NoneType' object has no attribute 'dropna'

Please run the testing suite locally and clear all linting errors:

************* Module openbb_terminal.stocks.discovery.news_sentiment_model
news_sentiment_model.py 63: C0301 Line too long (144/140) (line-too-long)
news_sentiment_model.py 63: W1309 Using an f-string that does not have any interpolated variables (f-string-without-interpolation)
news_sentiment_model.py 9: C0411 standard import "import datetime" should be placed before "import requests" (wrong-import-order)
news_sentiment_model.py 10: C0411 standard import "import os" should be placed before "import requests" (wrong-import-order)
news_sentiment_model.py 5: W0611 Unused import json (unused-import)
news_sentiment_model.py 8: W0611 Unused numpy imported as np (unused-import)
news_sentiment_model.py 9: W0611 Unused import datetime (unused-import)
news_sentiment_model.py 10: W0611 Unused import os (unused-import)

-----------------------------------
Your code has been rated at 7.89/10

deeleeramone · 2023-02-28T16:43:29Z

You should also update this branch to be current with origin/develop

deeleeramone · 2023-02-28T16:52:23Z

Type error in the controller, string is not a bool.

Please review the help messages for each argument, and correct the grammar.

Sai-132 · 2023-03-01T12:12:43Z

I have gone through all the above notes and updated the code accordingly.

I updated the origin/develop branch also.

I updated the type for all arguments.

Sai-132 · 2023-03-01T12:17:07Z

I have updated the API key also

deeleeramone · 2023-03-07T02:29:57Z

I have updated the API key also

Please resolve the merge conflicts, the branch has not been updated to be in sync with the develop branch until this has happened.

Sai-132 · 2023-03-08T08:10:13Z

Can you please check now
I have resolved all the conflicts

deeleeramone · 2023-03-09T01:15:52Z

Can you please check now
I have resolved all the conflicts

Please resolve all conflicts.

Sai-132 · 2023-03-09T05:32:59Z

resolved conflicts in the config_terminal file

deeleeramone · 2023-03-09T19:20:08Z

resolved conflicts in the config_terminal file

Not sure what you did there, but now the keys menu does not work. This error does not occur on the origin/develop branch. There should be no reason for you to have edited this file, and you should revert any changes made.

deeleeramone · 2023-03-09T19:37:22Z

openbb_terminal/sdk.py

@@ -20,6 +20,8 @@
    controllers as ctrl,
    models as model,
 )
+from openbb_terminal import feature_flags as obbff


Why are these items being added? Line 2 of the file says explicitly that this file is auto generated.

While Running this Command "python generate_sdk.py sort"
These lines are automatically generated.

deeleeramone · 2023-03-09T19:43:48Z

openbb_terminal/terminal_controller.py

@@ -413,6 +413,7 @@ def call_stocks(self, _):

        self.queue = self.load_class(StocksController, self.queue)

+


Why are we adding an empty new line here?

This empty new line may have been added by mistake.

Sai-132 · 2023-05-17T12:30:05Z

Fixed all merge conflicts and it is accessible without an API key.

Sai-132 · 2023-05-22T06:17:11Z

@minhhoang1023 We've already updated the code, fixed the conflicts, and your terminal users can access it without an API key.

stale

SaiKollipaka added 3 commits February 24, 2023 17:36

News sentiment feature added

0955f86

News sentiment feature added

4240c21

Integration test script file added

678a6e9

reviewpad bot added the feat M Medium T-Shirt size feature label Feb 27, 2023

Updated code as per PR Instructions

fab206c

SaiKollipaka added 2 commits March 1, 2023 16:03

API key setting and testing code updated

a1ca1af

Unused imports and line-too-long code updated

b6aa829

merging with develop branch

a4ed716

reviewpad bot added feat L Large T-Shirt size Feature and removed feat M Medium T-Shirt size feature labels Mar 8, 2023

SaiKollipaka and others added 2 commits March 9, 2023 10:59

Resolved conflicts in config_terminal file

9c9f2b2

Merge branch 'OpenBB-finance:develop' into feature/news_sentiment

b09cf70

Sai-132 and others added 2 commits March 9, 2023 17:49

Merge branch 'develop' into feature/news_sentiment

cbd6a9b

Merge branch 'develop' into feature/news_sentiment

f603d4d

deeleeramone reviewed Mar 9, 2023

View reviewed changes

Sai-132 and others added 2 commits March 10, 2023 16:19

Merge branch 'OpenBB-finance:develop' into feature/news_sentiment

ce5297a

removed empty line in terminal_controller file

f2bf2bb

Sai-132 force-pushed the feature/news_sentiment branch from 4bc7abe to 9beba4c Compare May 17, 2023 10:37

reviewpad bot added feat XS Extra small feature and removed feat M Medium T-Shirt size feature labels May 17, 2023

SaiKollipaka added 3 commits May 17, 2023 16:20

new changes updated

cd7e8c1

Code Updated

7151b49

New changes Updated

c049856

Sai-132 reopened this May 17, 2023

reviewpad bot added feat S Small T-Shirt size Feature and removed feat XS Extra small feature labels May 17, 2023

Sai-132 and others added 4 commits May 18, 2023 12:52

Merge branch 'develop' into feature/news_sentiment

f8c2799

Merge branch 'develop' into feature/news_sentiment

2e7f16e

Merge branch 'develop' into feature/news_sentiment

949625c

Resolved conflicts and code updated

4da9980

jmaslek added 8 commits May 23, 2023 16:25

Merge branch 'develop' into feature/news_sentiment

a803587

Small edits

a7380ec

missed a spelling error

406f39e

fix test

995a753

Merge branch 'develop' into feature/news_sentiment

2a2fb2c

Merge branch 'develop' into feature/news_sentiment

b749eb8

Lint

f0d0c08

pylint rewrite

c30a217

Merge branch 'develop' into feature/news_sentiment

aaaef8b

jmaslek approved these changes Jun 9, 2023

View reviewed changes

jmaslek enabled auto-merge June 9, 2023 16:11

jmaslek added this pull request to the merge queue Jun 9, 2023

Merged via the queue into OpenBB-finance:develop with commit 6784a9a Jun 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/news sentiment #4339

Feature/news sentiment #4339

Sai-132 commented Feb 27, 2023

deeleeramone commented Feb 28, 2023

Sai-132 commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

Sai-132 commented Mar 1, 2023

Sai-132 commented Mar 1, 2023

deeleeramone commented Mar 7, 2023

Sai-132 commented Mar 8, 2023

deeleeramone commented Mar 9, 2023

Sai-132 commented Mar 9, 2023

deeleeramone commented Mar 9, 2023

deeleeramone Mar 9, 2023

Sai-132 Mar 10, 2023

deeleeramone Mar 9, 2023

Sai-132 Mar 10, 2023

Sai-132 commented May 17, 2023

Sai-132 commented May 22, 2023

		@@ -413,6 +413,7 @@ def call_stocks(self, _):

		self.queue = self.load_class(StocksController, self.queue)

Feature/news sentiment #4339

Feature/news sentiment #4339

Conversation

Sai-132 commented Feb 27, 2023

Description

How has this been tested?

Checklist:

Others

deeleeramone commented Feb 28, 2023

Sai-132 commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

deeleeramone commented Feb 28, 2023

Sai-132 commented Mar 1, 2023

Sai-132 commented Mar 1, 2023

deeleeramone commented Mar 7, 2023

Sai-132 commented Mar 8, 2023

deeleeramone commented Mar 9, 2023

Sai-132 commented Mar 9, 2023

deeleeramone commented Mar 9, 2023

deeleeramone Mar 9, 2023

Choose a reason for hiding this comment

Sai-132 Mar 10, 2023

Choose a reason for hiding this comment

deeleeramone Mar 9, 2023

Choose a reason for hiding this comment

Sai-132 Mar 10, 2023

Choose a reason for hiding this comment

Sai-132 commented May 17, 2023

Sai-132 commented May 22, 2023