Remove references to environment variables #4633

hjoaquim · 2023-03-30T10:09:18Z

As the title suggest, this PR intends to remove as many references to the environment variables as possible. This allows us:

Greater control over how things change
Centralized approach leveraging SystemModel
Tied with the above: predictability

Functionality check list - from the user standpoint, everything should be the same:

DEBUG_MODE
a. w/ python terminal.py --debug
b. openbb
TEST_MODE
a. Run python terminal.py -t -l (check possible int tests) and then python terminal.py -t 2 --subproc 0 --verbose.
LOG_COLLECTION
a. if you're a dev and have this flag set to False on the env file, you should see no files on your archives dir on your logs folder.
ENABLE_AUTHENTICATION
a. if you've it set to Trueon you .env file and use openbb --login you should still be able to use the authenticated functionalities.

All of this can be setup on the .env file and will be initialzed to SystemModel accordingly during the terminal initialization.
DEBUG_MODE and TEST_MODE can obviouly, also be used throught the command line.

Not addressed environment variables that can still be found (use `CTRL+shift+F` to check it) that we probably want to keep:

PYDEVD_DISABLE_FILE_VALIDATION --> pyinstaller hook
REQUESTS_CA_BUNDLE --> Necessary for installer so that it can locate the correct certificates for API calls and https
SSL_CERT_FILE --> Necessary for installer so that it can locate the correct certificates for API calls and https
SERVER_SOFTWARE --> used for voila dashboards
PYTHONPATH --> used for dashboards

montezdesousa · 2023-03-30T15:26:37Z

Number 1: --debug flag seems to disable rich console formatting

Number 2: integration is not launching

Number 4. : openbb --login is also not launching the terminal with OPENBB_ENABLE_AUTHENTICATION='True' in the .env

montezdesousa · 2023-03-30T15:28:50Z

There are a few load_env_vars references which are loading environment variables as well. Should this go into the SystemModel as well?

openbb_terminal/config_terminal.py

hjoaquim · 2023-03-31T09:30:06Z

@montezdesousa would you give it another try (maybe on a fresh env)?

Everything seems alright on my end:
1.

2.

4.

montezdesousa · 2023-03-31T09:57:08Z

@montezdesousa would you give it another try (maybe on a fresh env)?

Everything seems alright on my end: 1. 2. 4.

You are right, don't know what was happening there!

…function

hjoaquim · 2023-03-31T11:23:04Z

load_env_vars

Good one. Was able to remove the function completely!

codecov · 2023-04-03T08:48:45Z

Codecov Report

❗ No coverage uploaded for pull request base (develop@405c7d6). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head ff9275d differs from pull request most recent head 0f007f6. Consider uploading reports for the commit 0f007f6 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             develop    #4633   +/-   ##
==========================================
  Coverage           ?   55.99%           
==========================================
  Files              ?      591           
  Lines              ?    53957           
  Branches           ?        0           
==========================================
  Hits               ?    30212           
  Misses             ?    23745           
  Partials           ?        0

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

hjoaquim · 2023-04-03T14:28:44Z

Related with: #4665
@montezdesousa after this PR gets merged, we should use the auth flag on the SystemModel to control the is_auth_enabled function

montezdesousa · 2023-04-03T16:00:30Z

Related with: #4665 @montezdesousa after this PR gets merged, we should use the auth flag on the SystemModel to control the is_auth_enabled function

What's left to do before merging?

hjoaquim · 2023-04-03T16:09:44Z

Related with: #4665 @montezdesousa after this PR gets merged, we should use the auth flag on the SystemModel to control the is_auth_enabled function

@montezdesousa did it here: 0f007f6

hjoaquim · 2023-04-03T16:10:08Z

Related with: #4665 @montezdesousa after this PR gets merged, we should use the auth flag on the SystemModel to control the is_auth_enabled function

What's left to do before merging?

everything's finished now, I think!

* removing references to test_mode as env variable * removing references to os.getenv * adding functions to change system properties * removing references to env * introducing set_system_variable and removing change_logging_suppress function * removing change_test_mode and change_debug_mode * removing change_log_collect * adjusting config_terminal and generate_sdk * generating the sdk * removing unused imoports * introducing DISABLE_STREAMLIT_WARNING * removing load_env_vars * test_print_help test * sync tests * rewrite tests * setting the auth to True as default --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

hjoaquim added 4 commits March 29, 2023 17:55

removing references to test_mode as env variable

ed212cd

removing references to os.getenv

cb90719

adding functions to change system properties

d11b164

removing references to env

9b38536

hjoaquim requested a review from montezdesousa March 30, 2023 10:09

reviewpad bot added the feat S Small T-Shirt size Feature label Mar 30, 2023

Merge branch 'develop' into hotfix/remove-envs

5224afa

hjoaquim changed the title ~~Remove mentions to environment variables~~ Remove references to environment variables Mar 30, 2023

Merge branch 'develop' into hotfix/remove-envs

2ee0837

montezdesousa reviewed Mar 30, 2023

View reviewed changes

openbb_terminal/config_terminal.py Outdated Show resolved Hide resolved

Merge branch 'develop' into hotfix/remove-envs

704e336

hjoaquim added 8 commits March 31, 2023 11:23

introducing set_system_variable and removing change_logging_suppress …

465c597

…function

removing change_test_mode and change_debug_mode

dd31369

removing change_log_collect

335cf71

adjusting config_terminal and generate_sdk

b982c85

generating the sdk

ef35b64

removing unused imoports

929d721

introducing DISABLE_STREAMLIT_WARNING

96bfe08

removing load_env_vars

1b21646

hjoaquim added 4 commits March 31, 2023 16:02

test_print_help test

c119d31

sync tests

5e43d29

rewrite tests

46ec119

Merge branch 'develop' into hotfix/remove-envs

6e5b81d

hjoaquim requested a review from montezdesousa April 1, 2023 17:24

Merge branch 'develop' into hotfix/remove-envs

a138f13

hjoaquim mentioned this pull request Apr 3, 2023

hotfix/ Avoid starting plots_backend twice on boot #4658

Merged

hjoaquim added 2 commits April 3, 2023 10:24

Merge branch 'develop' into hotfix/remove-envs

fbb1034

Merge branch 'develop' into hotfix/remove-envs

ff9275d

hjoaquim added 2 commits April 3, 2023 17:07

merge w/ resolved conflicts

f2404b8

setting the auth to True as default

0f007f6

montezdesousa approved these changes Apr 3, 2023

View reviewed changes

montezdesousa enabled auto-merge April 3, 2023 16:10

montezdesousa added this pull request to the merge queue Apr 3, 2023

Merged via the queue into OpenBB-finance:develop with commit 13a91af Apr 3, 2023

hjoaquim deleted the hotfix/remove-envs branch April 3, 2023 16:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove references to environment variables #4633

Remove references to environment variables #4633

hjoaquim commented Mar 30, 2023 •

edited

Loading

montezdesousa commented Mar 30, 2023 •

edited

Loading

montezdesousa commented Mar 30, 2023

hjoaquim commented Mar 31, 2023

montezdesousa commented Mar 31, 2023

hjoaquim commented Mar 31, 2023

codecov bot commented Apr 3, 2023 •

edited

Loading

hjoaquim commented Apr 3, 2023

montezdesousa commented Apr 3, 2023

hjoaquim commented Apr 3, 2023

hjoaquim commented Apr 3, 2023

Remove references to environment variables #4633

Remove references to environment variables #4633

Conversation

hjoaquim commented Mar 30, 2023 • edited Loading

As the title suggest, this PR intends to remove as many references to the environment variables as possible. This allows us:

Functionality check list - from the user standpoint, everything should be the same:

Not addressed environment variables that can still be found (use CTRL+shift+F to check it) that we probably want to keep:

montezdesousa commented Mar 30, 2023 • edited Loading

montezdesousa commented Mar 30, 2023

hjoaquim commented Mar 31, 2023

montezdesousa commented Mar 31, 2023

hjoaquim commented Mar 31, 2023

codecov bot commented Apr 3, 2023 • edited Loading

Codecov Report

hjoaquim commented Apr 3, 2023

montezdesousa commented Apr 3, 2023

hjoaquim commented Apr 3, 2023

hjoaquim commented Apr 3, 2023

hjoaquim commented Mar 30, 2023 •

edited

Loading

Not addressed environment variables that can still be found (use `CTRL+shift+F` to check it) that we probably want to keep:

montezdesousa commented Mar 30, 2023 •

edited

Loading

codecov bot commented Apr 3, 2023 •

edited

Loading