Adding stock price comparison via -c flag

[Avani1994]

Adding stock price comparison via -c flag

Added a compare flag in twitter sentiment analysis to allow see the movements in stock price alongside the sentiment. It's just a small enhancement to the sentiment command under /stocks/ba/.

I just felt stock price movements along with sentiment will be really helpful from customer point of view.

None of the dependencies are required for this change.

How has this been tested?

Couldn't run tests, as it was asking to uninstall brotlipy and conda uninstall didn't do the job, hopefully CI should catch failing tests if any

• Provide instructions so we can reproduce.
  $/stocks/ba sentiment -c True

Output:

• Please also list any relevant details for your test configuration. - None

Checklist:

• Update our Hugo documentation following these guidelines.
• 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 scripts file.

[DidierRLopes]

Nice one @Avani1994 !!

I put my comments below 😄

[DidierRLopes]

Here the fig size should be plot_autoscale()

[Avani1994]

I see, I tried this, but then with three figs, the individual plots are quiet small. Wouldn't that be a problem?

[DidierRLopes]

That may be because our default is not ideal, but this should be able to be configurable by the user

[DidierRLopes]

Because the ax1 and ax2 do not change regardless of whether we display stock price or not. We should do something like the following pseudo-code:

if compare:
    ax1,ax2,ax3 are created
else:
   ax1,ax2 are created

populate ax1 and ax2 (this avoids repeated code)

if compare:
   populate ax3 with stock price

set theme

This allows to minimize duplicated code and makes it easier for debug

[Avani1994]

I see yeah this makes sense to me, we have to just write if compare twice, i thought that wouldn't be good idea, but yeah we can do this.

[DidierRLopes]

Makes it easier from the readability perspective and maintenance as well since there isn't repeated code

[DidierRLopes]

For true/false flags you can use here "store_true" as action and remove both the type and the default

[Avani1994]

That's good advice :)

[DidierRLopes]

@Avani1994 for the tests to pass you need to run black linting to the helper_funcs

@piiq this is also failing in the compose_export_path do you know why?

[piiq]

thank you @Avani1994

re: compose_export_path
The error says NameError: name 'Tuple' is not defined.
Add Tuple on line 7 in openbb_terminal/helper_funcs.py to resolve, although the import is available in main so it that line wasn't edited it should work fine once the PR branch is synced with main.

[piiq]

this is why tests are failing

[DidierRLopes]

@Avani1994 you just need to fix the test for the -c flag 😄

[DidierRLopes]

Nice work @Avani1994 !