Feature/companies house

[kulbinderdio]

Description

• [​​Addition of new data source, UK Companies House. Now able to search, check details and download filings including accounts ] Summary of the change / bug fix.
• Link # issue, if applicable.
• [

] Screenshot of the feature or the bug before/after fix, if applicable. - [ Wanted the ability to investigate companies including their filed accounts] Relevant motivation and context. - [Required Companies House API Key ] List any dependencies that are required for this change.

How has this been tested?

• Please describe the tests that you ran to verify your changes.
  Used several different names for search functionality, e.g. search Shell Oil
  Used the company number returned to load that company, e.g. load 06791769
  Used following commands to review company data: officers, signifcontrol, filings
  Used data returned from filings command to download actual document, e.g. filingdocument MzM3NTQzMzc0NGFkaXF6a2N4
  Can also look at individual company officers, etc by passing in company number parameter, e.g.
• Provide instructions so we can reproduce.
• Please also list any relevant details for your test configuration.

• Make sure affected commands still run in terminal
• [ Added new commands into SDK and checked] 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

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

[kulbinderdio]

Could the failures in my tests be due to the fact the new service requires a key?

[codecov]

Codecov Report

Patch coverage: 27.27% and project coverage change: -0.29% ⚠️

Comparison is base (df9a154) 58.29% compared to head (d5c52bd) 58.00%.
Report is 350 commits behind head on develop.

❗ Current head d5c52bd differs from pull request most recent head 64032a6. Consider uploading reports for the commit 64032a6 to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4721      +/-   ##
===========================================
- Coverage    58.29%   58.00%   -0.29%     
===========================================
  Files          588      591       +3     
  Lines        53666    53903     +237     
===========================================
- Hits         31283    31266      -17     
- Misses       22383    22637     +254     

Files Changed	Coverage Δ
openbb_terminal/core/config/paths_helper.py	50.00% <ø> (ø)
...erminal/core/sdk/controllers/alt_sdk_controller.py	0.00% <0.00%> (ø)
...inal/core/sdk/controllers/crypto_sdk_controller.py	0.00% <ø> (ø)
...inal/core/sdk/controllers/stocks_sdk_controller.py	0.00% <ø> (ø)
openbb_terminal/core/sdk/models/alt_sdk_model.py	0.00% <0.00%> (ø)
...penbb_terminal/core/sdk/models/crypto_sdk_model.py	0.00% <0.00%> (ø)
...bb_terminal/core/sdk/models/portfolio_sdk_model.py	0.00% <0.00%> (ø)
...penbb_terminal/core/sdk/models/stocks_sdk_model.py	0.00% <ø> (ø)
openbb_terminal/core/sdk/sdk_helpers.py	37.69% <ø> (+0.76%)	⬆️
openbb_terminal/core/sdk/trailmap.py	92.68% <ø> (ø)
... and 26 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jmaslek]

This looks awesome! Small missing detail in the i18n file. No description on the charges:

│     search             search for companies by name                                                                                                                                                         │
│     load               retrieve basic company details by company registration number                                                                                                                        │
│     officers           retrieve company officies                                                                                                                                                            │
│     signifcontrol      retrieve those with significant control over the company                                                                                                                             │
│     filings            retrieve list of documents filed with Companies House (Max of 100 at one time)                                                                                                       │
│     filingdocument     download filed document                                                                                                                                                              │
│     charges            alternative/companieshouse/charges       

[kulbinderdio]

thanks James, just trying to get things closed out as I haven't had much time lately. Hopefully not too much more to do

cheers

[kulbinderdio]

for the life of me I can't see what the issue is with the print_help test. Both Actual and Expected look identical. I suspect it might be something to do with hidden chars (life feed?) and have recreated the text file and still keep getting the same issue. Any ideas @jmaslek ?