diff options
author | montezdesousa <79287829+montezdesousa@users.noreply.github.com> | 2022-08-08 14:19:33 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-08 14:19:33 +0100 |
commit | 9ff9d121a88618eb78557b8fee2496089920d652 (patch) | |
tree | 329af8114bf6b1e5dd86e122561e081c468cd3d7 | |
parent | 32c656b7f022fc9244c2c7fd38a200046582a5d0 (diff) |
Rename ecocal to events and fix categories filtering (#2268)
* fix investpy categories filter
* change ecocal to events
* update website doc
* rewrite menu help test
* update menu command description
* update main.yml
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
-rw-r--r-- | i18n/en.yml | 2 | ||||
-rw-r--r-- | openbb_terminal/economy/economy_controller.py | 25 | ||||
-rw-r--r-- | openbb_terminal/economy/investingcom_view.py | 2 | ||||
-rw-r--r-- | tests/openbb_terminal/economy/txt/test_economy_controller/test_print_help.txt | 2 | ||||
-rw-r--r-- | website/content/terminal/economy/ecocal/_index.md | 45 | ||||
-rw-r--r-- | website/content/terminal/economy/events/_index.md | 46 | ||||
-rwxr-xr-x | website/data/menu/main.yml | 4 |
7 files changed, 62 insertions, 64 deletions
diff --git a/i18n/en.yml b/i18n/en.yml index 8b92ea53193..2377615a885 100644 --- a/i18n/en.yml +++ b/i18n/en.yml @@ -782,7 +782,7 @@ en: economy/index: find and plot any (major) index on the market economy/treasury: obtain U.S. treasury rates economy/ycrv: show sovereign yield curves - economy/ecocal: display economic calendar + economy/events: display economic calendar economy/plot: plot data from the above commands together economy/rtps: real-time performance sectors economy/valuation: valuation of sectors, industry, country diff --git a/openbb_terminal/economy/economy_controller.py b/openbb_terminal/economy/economy_controller.py index d96e6eaba4d..8f68d68e2c0 100644 --- a/openbb_terminal/economy/economy_controller.py +++ b/openbb_terminal/economy/economy_controller.py @@ -64,7 +64,7 @@ class EconomyController(BaseController): "industry", "bigmac", "ycrv", - "ecocal", + "events", ] CHOICES_MENUS = ["pred", "qa"] @@ -189,21 +189,21 @@ class EconomyController(BaseController): c: None for c in investingcom_model.BOND_COUNTRIES } - self.choices["ecocal"]["-c"] = { + self.choices["events"]["-c"] = { c: None for c in investingcom_model.CALENDAR_COUNTRIES } - self.choices["ecocal"]["--countries"] = { + self.choices["events"]["--countries"] = { c: None for c in investingcom_model.CALENDAR_COUNTRIES } - self.choices["ecocal"]["-i"] = { + self.choices["events"]["-i"] = { c: None for c in investingcom_model.IMPORTANCES } - self.choices["ecocal"]["--importances"] = { + self.choices["events"]["--importances"] = { c: None for c in investingcom_model.IMPORTANCES } - self.choices["ecocal"]["--cat"] = { + self.choices["events"]["--cat"] = { c: None for c in investingcom_model.CATEGORIES } @@ -258,7 +258,7 @@ class EconomyController(BaseController): mt.add_cmd("map", "Finviz") mt.add_cmd("bigmac", "NASDAQ Datalink") mt.add_cmd("ycrv", "Investing.com / FRED") - mt.add_cmd("ecocal", "Investing.com") + mt.add_cmd("events", "Investing.com") mt.add_raw("\n") mt.add_cmd("rtps", "Alpha Vantage") mt.add_cmd("valuation", "Finviz") @@ -1030,13 +1030,13 @@ class EconomyController(BaseController): ) @log_start_end(log=logger) - def call_ecocal(self, other_args: List[str]): - """Process ecocal command""" + def call_events(self, other_args: List[str]): + """Process events command""" parser = argparse.ArgumentParser( add_help=False, formatter_class=argparse.ArgumentDefaultsHelpFormatter, - prog="ecocal", - description="Economic calendar. If no start or end dates, default is the current day.", + prog="events", + description="Economic calendar. If no start or end dates, default is the current day high importance events.", ) parser.add_argument( "-c", @@ -1091,9 +1091,6 @@ class EconomyController(BaseController): if isinstance(ns_parser.country, list): ns_parser.country = " ".join(ns_parser.country) - if ns_parser.categories: - ns_parser.categories = ns_parser.categories.replace("_", " ") - investingcom_model.check_correct_country( ns_parser.country, investingcom_model.CALENDAR_COUNTRIES ) diff --git a/openbb_terminal/economy/investingcom_view.py b/openbb_terminal/economy/investingcom_view.py index a420427502e..1c455b5faac 100644 --- a/openbb_terminal/economy/investingcom_view.py +++ b/openbb_terminal/economy/investingcom_view.py @@ -192,6 +192,6 @@ def display_economic_calendar( export_data( export, os.path.dirname(os.path.abspath(__file__)), - "ecocal", + "events", df, ) diff --git a/tests/openbb_terminal/economy/txt/test_economy_controller/test_print_help.txt b/tests/openbb_terminal/economy/txt/test_economy_controller/test_print_help.txt index e9bc7b3d016..81eef4ab375 100644 --- a/tests/openbb_terminal/economy/txt/test_economy_controller/test_print_help.txt +++ b/tests/openbb_terminal/economy/txt/test_economy_controller/test_print_help.txt @@ -3,7 +3,7 @@ map S&P500 index stocks map [Finviz] bigmac The Economist Big Mac index [NASDAQ Datalink] ycrv show sovereign yield curves [Investing.com / FRED] - ecocal display economic calendar [Investing.com] + events display economic calendar [Investing.com] rtps real-time performance sectors [Alpha Vantage] valuation valuation of sectors, industry, country [Finviz] diff --git a/website/content/terminal/economy/ecocal/_index.md b/website/content/terminal/economy/ecocal/_index.md deleted file mode 100644 index 4ac9c8a3e34..00000000000 --- a/website/content/terminal/economy/ecocal/_index.md +++ /dev/null @@ -1,45 +0,0 @@ -``` -usage: ecocal [-c COUNTRY [COUNTRY ...]] [-i {high,medium,low,all}] - [-cat {Employment,Credit,Balance,Economic Activity,Central Banks,Bonds,Inflation,Confidence Index} [{Employment,Credit,Balance,Economic Activity,Central Banks,Bonds,Inflation,Confidence Index} ...]] - [-s START_DATE] [-e END_DATE] [-h] [--export EXPORT] [--raw] -``` -Economic calendar. - -``` -optional arguments: - -c COUNTRY [COUNTRY ...], --country COUNTRY [COUNTRY ...] - Display calendar for specific country. (default: united states) - -i {high,medium,low,all}, --importances {high,medium,low,all} - Event importance classified as high, medium, low or all. (default: all) - -cat {employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} [{employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} ...], --categories {employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} [{employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} ...] - Event category. (default: None) - -s START_DATE, --start_date START_DATE - The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) (default: None) - -e END_DATE, --end_date END_DATE - The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) (default: None) - -h, --help show this help message (default: False) - --export EXPORT Export raw data into csv, json, xlsx (default: ) - --raw Flag to display raw data (default: False) -``` - -Example: -``` -2022 Jul 11, 16:55 (๐ฆ) /economy/ $ ecocal -c united states -i medium -cat inflation -s 2022-06-15 -e 2022-07-01 - - Economic Calendar (GMT +1:00) -โโโโโโโโโโโโโโณโโโโโโโโณโโโโโโโโโโโโโโโโณโโโโโโโโโโโณโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโณโโโโโโโโโโโณโโโโโโโโโโโ -โ date โ time โ zone โ currency โ importance โ event โ actual โ forecast โ previous โ -โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ -โ 15/06/2022 โ 14:30 โ united states โ USD โ medium โ Export Price Index (MoM) (May) โ 2.8% โ 1.3% โ 0.8% โ -โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค -โ 15/06/2022 โ 14:30 โ united states โ USD โ medium โ Import Price Index (MoM) (May) โ 0.6% โ 1.1% โ 0.4% โ -โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค -โ 29/06/2022 โ 14:30 โ united states โ USD โ medium โ GDP Price Index (QoQ) (Q1) โ 8.3% โ 8.1% โ 8.1% โ -โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค -โ 30/06/2022 โ 14:30 โ united states โ USD โ medium โ Core PCE Price Index (YoY) (May) โ 4.7% โ 4.8% โ 4.9% โ -โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค -โ 30/06/2022 โ 14:30 โ united states โ USD โ medium โ PCE Price index (YoY) (May) โ 6.3 โ โ 6.3 โ -โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค -โ 30/06/2022 โ 14:30 โ united states โ USD โ medium โ PCE price index (MoM) (May) โ 0.6% โ โ 0.2% โ -โโโโโโโโโโโโโโดโโโโโโโโดโโโโโโโโโโโโโโโโดโโโโโโโโโโโดโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโดโโโโโโโโโโโดโโโโโโโโโโโ -``` diff --git a/website/content/terminal/economy/events/_index.md b/website/content/terminal/economy/events/_index.md new file mode 100644 index 00000000000..eb02db9de83 --- /dev/null +++ b/website/content/terminal/economy/events/_index.md @@ -0,0 +1,46 @@ +``` +usage: events [-c COUNTRY [COUNTRY ...]] [-i {high,medium,low,all}] [--cat {employment,credit,balance,economic_activity,central_banks,bonds,inflation,confidence_index}] + [-s START_DATE] [-e END_DATE] [-h] [--export EXPORT] [--raw] [-l LIMIT] +``` +Economic calendar. If no start or end dates, default is the current day high importance events. + +``` +optional arguments: + -c COUNTRY [COUNTRY ...], --country COUNTRY [COUNTRY ...] + Display calendar for specific country. (default: united states) + -i {high,medium,low,all}, --importances {high,medium,low,all} + Event importance classified as high, medium, low or all. (default: all) + -cat {employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} [{employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} ...], --categories {employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} [{employment,credit,balance,economic activity,central banks,bonds,inflation,confidence index} ...] + Event category. (default: None) + -s START_DATE, --start_date START_DATE + The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) (default: None) + -e END_DATE, --end_date END_DATE + The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) (default: None) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx (default: ) + --raw Flag to display raw data (default: False) + -l LIMIT, --limit LIMIT + Number of entries to show in data. (default: 100) +``` + +Example: +``` +2022 Aug 08, 09:41 (๐ฆ) /economy/ $ events -c united states -i medium --cat inflation -s 2022-06-15 -e 2022-07-01 + + United States economic calendar (GMT +1:00) +โโโโโโโโโโโโโโณโโโโโโโโณโโโโโโโโโโโณโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโณโโโโโโโโโโโณโโโโโโโโโโโ +โ Date โ Time โ Currency โ Importance โ Event โ Actual โ Forecast โ Previous โ +โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ +โ 2022-06-15 โ 14:30 โ USD โ Medium โ Export Price Index (MoM) (May) โ 2.8% โ 1.3% โ 0.8% โ +โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค +โ 2022-06-15 โ 14:30 โ USD โ Medium โ Import Price Index (MoM) (May) โ 0.6% โ 1.1% โ 0.4% โ +โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค +โ 2022-06-29 โ 14:30 โ USD โ Medium โ GDP Price Index (QoQ) (Q1) โ 8.3% โ 8.1% โ 8.1% โ +โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค +โ 2022-06-30 โ 14:30 โ USD โ Medium โ Core PCE Price Index (YoY) (May) โ 4.7% โ 4.8% โ 4.9% โ +โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค +โ 2022-06-30 โ 14:30 โ USD โ Medium โ PCE Price index (YoY) (May) โ 6.3 โ โ 6.3 โ +โโโโโโโโโโโโโโผโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโผโโโโโโโโโโโผโโโโโโโโโโโค +โ 2022-06-30 โ 14:30 โ USD โ Medium โ PCE price index (MoM) (May) โ 0.6% โ โ 0.2% โ +โโโโโโโโโโโโโโดโโโโโโโโดโโโโโโโโโโโดโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโดโโโโโโโโโโโดโโโโโโโโโโโ +``` diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index 4a990f2c687..78692d80f1c 100755 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -991,8 +991,8 @@ main: ref: "/terminal/economy/yield" - name: ycrv ref: "/terminal/economy/ycrv" - - name: ecocal - ref: "/terminal/economy/ecocal" + - name: events + ref: "/terminal/economy/events" - name: plot ref: "/terminal/economy/plot" - name: rtps |