Index
+ +
+
+
+
+
+
+
+
+
+ ' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/+1build/html/genindex.html b/docs/+1build/html/genindex.html new file mode 100644 index 0000000..ef7dee1 --- /dev/null +++ b/docs/+1build/html/genindex.html @@ -0,0 +1,112 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/get_series.html b/docs/+1build/html/get_series.html
new file mode 100644
index 0000000..efd8ba3
--- /dev/null
+++ b/docs/+1build/html/get_series.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/home.html b/docs/+1build/html/home.html
new file mode 100644
index 0000000..a134012
--- /dev/null
+++ b/docs/+1build/html/home.html
@@ -0,0 +1,224 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get_series Function
+The get_series function is designed to fetch economic data series from a specified API and return it formatted as a pandas DataFrame, making extensive use of various parameters to fine-tune the data retrieval process.
Parameters
+-
+
- indexstr or tuple
Identifier(s) for the data series to fetch. This can be a single string for one series or a tuple of strings for multiple series.
+
+- start_datestr, optional
The start date for the data retrieval in ‘DD-MM-YYYY’ format. By default, this calls
+default_start_date_fnc().
+- end_datestr, optional
The end date for the data retrieval in ‘DD-MM-YYYY’ format. By default, this calls
+default_end_date_fnc().
+- frequencystr, optional
The frequency at which data should be retrieved, options include ‘monthly’, ‘weekly’, ‘annually’, ‘semimonthly’, ‘semiannually’, and ‘business’.
+
+- formulasstr or tuple, optional
Computation methods to apply to the data series, such as ‘level’, ‘percentage_change’, ‘difference’, ‘year_to_year_percent_change’, or ‘year_to_year_differences’.
+
+- aggregationstr or tuple, optional
Aggregation methods to apply to the data, options include ‘avg’, ‘min’, ‘max’, ‘first’, ‘last’, and ‘sum’.
+
+- cachebool, optional
If True, uses cached data when available to speed up the data retrieval process. Default is False.
+
+- proxystr, optional
The URL of the proxy server to use for the requests. Default is None.
+
+- proxiesdict, optional
A dictionary of proxies to use for the request. Default is None.
+
+- debugbool, optional
If True, runs the function in debug mode, providing additional debug information without making a real API request. Default is False.
+
+- api_keystr, optional
The API key required for accessing the data. Initially, it can be saved using the
+save("APIKEY")function or via command line with$ evdspy save.
+
Returns
+-
+
- pd.DataFrame
A pandas DataFrame containing the retrieved data series.
+
+
Raises
+-
+
- ValueError
Raised if an invalid API key is provided or required parameters are missing.
+
+
Examples
+Basic usage:
+index = "TP.ODEMGZS.BDTTOPLAM"
+df = get_series(index, start_date="01-01-2020", end_date="01-01-2021", frequency="monthly")
+print(df.head())
+Using multiple indexes and cache:
+indexes = ("TP.ODEMGZS.BDTTOPLAM", "TP.ODEMGZS.ABD")
+df = get_series(indexes, start_date="01-01-2020", frequency="monthly", cache=True)
+print(df.head())
+template = """
+
+TP.ODEMGZS.BDTTOPLAM
+TP.ODEMGZS.ABD
+"""
+
+df = get_series(template, start_date="01-01-2020", frequency="monthly", cache=True)
+print(df.head())
+Applying formulas and aggregation:
+df = get_series(template, start_date="01-01-2020", formulas="level", aggregation="sum")
+print(df.head())
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/index.html b/docs/+1build/html/index.html
new file mode 100644
index 0000000..f35bd3f
--- /dev/null
+++ b/docs/+1build/html/index.html
@@ -0,0 +1,168 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Welcome to evdspy Documentation
+
+
+
+evdspy is an open-source Python interface that simplifies making requests to the Central Bank of the Republic of Turkey (CBRT) Economic Data Service (EDS). It provides efficient request handling by caching results, a user-friendly menu for data inquiries, and capabilities for handling complex data structures through an accessible API.
+View Source Code
+You can view the source code for this project on GitHub: View Source.
+What’s New
+Updated on this version:
+-
+
The API key parameter has now been moved to the HTTP header to enhance security and ensure that sensitive information is not exposed in URLs.
+Added a new function,
get_series, which enhances the way data groups and series are handled.
+Deprecated: The
get_datagroupfunction will be deprecated in future versions;get_serieswill cover its functionalities.
+
Key Features
+-
+
API Key Management: Automatically saves the API key to a file when provided to the
get_seriesfunction, ignoring subsequent entries unless explicitly updated.
+Visual and Textual Menu Options: Provides both a visual and textual menu to facilitate user interaction for setting up projects, creating output folders, and preparing configuration files.
+Data Request Handling: Utilizes caching to optimize data retrieval, minimizing redundant requests and speeding up the data access process.
+
Installation
+To install evdspy, simply run the following command:
+pip install evdspy -U
+Quick Start
+Here’s a quick example to get you started with using evdspy:
+from evdspy import get_series, default_start_date_fnc, default_end_date_fnc
+
+index = "TP.ODEMGZS.BDTTOPLAM", "TP.ODEMGZS.ABD"
+df = get_series(index, frequency="monthly", start_date=default_start_date_fnc(), end_date=default_end_date_fnc(), aggregation=("avg",), cache=True)
+print(df)
+API Usage Examples
+
+
+
+
+Example of using the get_series function to retrieve data.
+ 1from evdspy import *
+ 2
+ 3template = """TP_GSYIH01_GY_CF
+ 4TP_GSYIH02_GY_CF
+ 5TP_GSYIH03_GY_CF
+ 6TP_GSYIH04_GY_CF
+ 7TP_GSYIH05_GY_CF
+ 8TP_GSYIH06_GY_CF
+ 9TP_GSYIH07_GY_CF
+10TP_GSYIH08_GY_CF
+11TP_GSYIH09_GY_CF
+12TP_GSYIH10_GY_CF
+13TP_GSYIH11_GY_CF
+14TP_GSYIH14_GY_CF
+15TP_GSYIH15_GY_CF
+16TP_GSYIH16_GY_CF
+17"""
+18
+19df = get_series(template, debug=False)
+20print(df)
+21
+22
+Learn More
+For more detailed information on all functions and their parameters, refer to the Modules section or visit our [GitHub Repository](https://github.com/SermetPekin/evdspy-repo).
+Disclaimer
+Please note that evdspy is not officially affiliated with or endorsed by the CBRT. It is developed and maintained under an MIT license by independent developers. Use of this tool should comply with all applicable laws and API usage guidelines provided by the CBRT.
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/menu.html b/docs/+1build/html/menu.html
new file mode 100644
index 0000000..b98ccf7
--- /dev/null
+++ b/docs/+1build/html/menu.html
@@ -0,0 +1,156 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Welcome to evdspy’s documentation!
+
+
+Contents:
+-
+
- Welcome to evdspy Documentation + +
- get_series Function
-
+
- Parameters +
- Returns +
- Raises +
- Examples +
+ - setup Function + +
- save Function + +
- menu Function + +
Indices and tables
+-
+
- +
- +
- +
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/objects.inv b/docs/+1build/html/objects.inv
new file mode 100644
index 0000000..2fa2f8c
--- /dev/null
+++ b/docs/+1build/html/objects.inv
@@ -0,0 +1,5 @@
+# Sphinx inventory version 2
+# Project: evdspy
+# Version:
+# The remainder of this file is compressed using zlib.
+xڅA E= &n]&M\4hBhkx=ObahhgVsV+(RoHZNCxV0L*fkZ+i:ș0c HvTKh}=_U|R3
{ kF'.iK(attf0}B}4iko.
\ No newline at end of file
diff --git a/docs/+1build/html/save.html b/docs/+1build/html/save.html
new file mode 100644
index 0000000..9af1fb7
--- /dev/null
+++ b/docs/+1build/html/save.html
@@ -0,0 +1,153 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/search.html b/docs/+1build/html/search.html
new file mode 100644
index 0000000..4790405
--- /dev/null
+++ b/docs/+1build/html/search.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ save Function
+The save function is designed to save an API key into your application’s configuration or a designated storage mechanism. It ensures the API key is valid and prompts the user for input if the provided key is not valid or if no key is provided.
Function Signature
+Parameters
+-
+
- api_keystr, optional
The API key to be saved. If not provided or if an invalid key is passed, the user is prompted to input a valid API key interactively.
+
+
Behavior and Errors
+The function checks if the provided api_key is a valid string. If the api_key is None or not a string, it attempts to set the API key through an interactive input method provided by set_apikey_input().
+This function should handle cases where: +- An API key is not provided, leading to an interactive input request. +- An invalid API key type is provided, prompting a type check and subsequent interactive input request.
+The final step involves checking the validity of the API key with check_apikey_and_then_save(api_key), which presumably implements further validation and storage mechanisms.
+Example Usage
+Here is how you might typically call this function:
+# Example of saving an API key directly
+save("your_api_key_here")
+
+# Example when no API key is provided; this will trigger an interactive input prompt
+save()
+This function is crucial for scenarios where secure and valid API key storage is necessary for the operation of your application, particularly in environments where configuration changes dynamically or where user input is required to initiate configuration.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/+1build/html/searchindex.js b/docs/+1build/html/searchindex.js
new file mode 100644
index 0000000..6d56f42
--- /dev/null
+++ b/docs/+1build/html/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"API Usage Examples": [[1, "api-usage-examples"]], "Behavior and Errors": [[4, "behavior-and-errors"]], "Contents:": [[2, null]], "Disclaimer": [[1, "disclaimer"]], "Example Usage": [[3, "example-usage"], [4, "example-usage"], [5, "example-usage"]], "Examples": [[0, "examples"]], "Function Details": [[3, "function-details"], [5, "function-details"]], "Function Signature": [[4, "function-signature"]], "Indices and tables": [[2, "indices-and-tables"]], "Installation": [[1, "installation"]], "Key Features": [[1, "key-features"]], "Learn More": [[1, "learn-more"]], "Menus and Commands": [[1, "menus-and-commands"]], "Parameters": [[0, "parameters"], [3, "parameters"], [4, "parameters"]], "Purpose": [[5, "purpose"]], "Quick Start": [[1, "quick-start"]], "Raises": [[0, "raises"], [3, "raises"]], "Returns": [[0, "returns"], [3, "returns"]], "Usage": [[5, "usage"]], "View Source Code": [[1, "view-source-code"]], "Welcome to evdspy Documentation": [[1, "welcome-to-evdspy-documentation"]], "Welcome to evdspy\u2019s documentation!": [[2, "welcome-to-evdspy-s-documentation"]], "What\u2019s New": [[1, "what-s-new"]], "get_series Function": [[0, "get-series-function"]], "menu Function": [[3, "menu-function"]], "save Function": [[4, "save-function"]], "setup Function": [[5, "setup-function"]]}, "docnames": ["get_series", "home", "index", "menu", "save", "setup"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["get_series.rst", "home.rst", "index.rst", "menu.rst", "save.rst", "setup.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 3, 4, 5], "0": 3, "01": 0, "2020": 0, "2021": 0, "A": [0, 3], "By": 0, "For": 1, "If": [0, 3, 4], "It": [1, 4], "The": [0, 1, 3, 4, 5], "To": 1, "abd": [0, 1], "access": [0, 1], "action": 3, "ad": 1, "addit": [0, 5], "affili": 1, "after": 3, "aggreg": [0, 1], "all": [1, 5], "an": [0, 1, 3, 4], "ani": 5, "annual": 0, "api": [0, 2, 4], "api_kei": [0, 4], "apikei": 0, "appli": 0, "applic": [1, 3, 4, 5], "ar": [0, 1, 5], "argument": 5, "attempt": 4, "automat": 1, "avail": [0, 3], "avg": [0, 1], "bank": 1, "base": 5, "basic": 0, "bdttoplam": [0, 1], "been": 1, "befor": 5, "begin": 5, "behavior": 2, "between": 3, "bool": 0, "both": 1, "busi": 0, "cach": [0, 1], "call": [0, 4, 5], "can": [0, 1], "capabl": 1, "case": 4, "cbrt": 1, "central": 1, "chang": 4, "check": 4, "check_apikey_and_then_sav": 4, "choic": 3, "choos": 3, "chosen": 3, "cli": 3, "code": 2, "com": 1, "command": [0, 2], "complex": 1, "compli": 1, "comput": 0, "configur": [1, 4, 5], "consol": 1, "contain": 0, "correctli": 5, "cover": 1, "creat": [1, 5], "create_series_text_exampl": 5, "crucial": 4, "data": [0, 1, 5], "datafram": 0, "date": 0, "dd": 0, "debug": [0, 1], "default": 0, "default_end_date_fnc": [0, 1], "default_start_date_fnc": [0, 1], "demonstr": 3, "deprec": 1, "design": [0, 4, 5], "detail": [1, 2], "develop": 1, "df": [0, 1], "dict": 0, "dictionari": 0, "differ": [0, 3], "directli": 4, "disclaim": 2, "displai": 3, "doe": 5, "dynam": 4, "econom": [0, 1], "ed": 1, "effici": 1, "encapsul": 5, "end": 0, "end_dat": [0, 1], "endors": 1, "enhanc": 1, "ensur": [1, 4, 5], "entri": 1, "environ": [4, 5], "error": 2, "essenti": 5, "evdspi": [0, 3, 5], "exampl": 2, "execut": 5, "explicitli": 1, "expos": 1, "extens": 0, "facilit": 1, "fals": [0, 1], "featur": 2, "fetch": 0, "file": 1, "final": 4, "fine": 0, "first": [0, 3], "folder": 1, "follow": 1, "format": 0, "formula": 0, "frequenc": [0, 1], "friendli": 1, "from": [0, 1, 3, 5], "function": [1, 2], "further": 4, "futur": 1, "gener": 5, "get": 1, "get_datagroup": 1, "get_seri": [1, 2], "github": 1, "group": 1, "guidelin": 1, "ha": 1, "handl": [1, 4], "head": 0, "header": 1, "help": 1, "here": [1, 3, 4], "how": [3, 4], "http": 1, "i": [0, 1, 3, 4, 5], "identifi": 0, "ignor": 1, "implement": 4, "import": [1, 3, 5], "includ": 0, "independ": 1, "index": [0, 1, 2, 3], "inform": [0, 1], "initi": [0, 4, 5], "input": [3, 4], "inquiri": 1, "instal": 2, "int": 3, "interact": [1, 3, 4, 5], "interfac": 1, "invalid": [0, 4], "involv": 4, "its": 1, "kei": [0, 2, 4], "last": 0, "law": 1, "lead": 4, "learn": 2, "level": 0, "licens": 1, "lifecycl": 5, "line": 0, "list": 3, "main": 1, "maintain": 1, "make": [0, 1], "manag": 1, "max": 0, "mechan": 4, "menu": 2, "method": [0, 4], "might": 4, "min": 0, "minim": 1, "miss": 0, "mit": 1, "mm": 0, "mode": 0, "modul": [1, 2], "monthli": [0, 1], "more": 2, "move": 1, "multipl": [0, 5], "necessari": [4, 5], "new": 2, "none": [0, 4], "note": 1, "now": 1, "occur": 5, "odemgz": [0, 1], "offici": 1, "one": 0, "onsetup": 5, "open": 1, "oper": [4, 5], "optim": 1, "option": [0, 1, 3, 4], "other": 5, "our": 1, "output": 1, "page": 2, "panda": 0, "paramet": [1, 2], "particularli": 4, "pass": 4, "pd": 0, "percentage_chang": 0, "perform": 5, "phase": 5, "pip": 1, "pleas": 1, "prepar": [1, 5], "preparatori": 5, "presum": 4, "print": [0, 1, 3], "process": [0, 1], "project": 1, "prompt": 4, "provid": [0, 1, 4], "proxi": 0, "purpos": 2, "python": 1, "quick": 2, "rais": 2, "real": 0, "redund": 1, "refer": 1, "repo": 1, "repositori": 1, "repres": 3, "republ": 1, "request": [0, 1, 4], "requir": [0, 3, 4], "resourc": 5, "result": 1, "retriev": [0, 1], "return": [2, 5], "run": [0, 1], "save": [0, 1, 2], "scenario": 4, "search": 2, "section": 1, "secur": [1, 4], "select": 3, "semiannu": 0, "semimonthli": 0, "sensit": 1, "seri": [0, 1], "sermetpekin": 1, "server": 0, "servic": 1, "set": [1, 4, 5], "set_apikey_input": 4, "setup": [1, 2], "setupiniti": 5, "should": [0, 1, 4], "signatur": 2, "simpl": 3, "simpli": 1, "simplifi": 1, "singl": 0, "sourc": 2, "specif": 5, "specifi": 0, "speed": [0, 1], "start": [0, 2], "start_dat": [0, 1], "start_setup_config": 5, "step": [4, 5], "storag": 4, "str": [0, 3, 4], "string": [0, 3, 4], "structur": [1, 5], "subsequ": [1, 4], "sum": 0, "task": 5, "templat": [0, 1], "termin": 1, "textual": 1, "thi": [0, 1, 3, 4, 5], "three": 3, "through": [1, 4], "tool": 1, "tp": [0, 1], "tp_gsyih01_gy_cf": 1, "tp_gsyih02_gy_cf": 1, "tp_gsyih03_gy_cf": 1, "tp_gsyih04_gy_cf": 1, "tp_gsyih05_gy_cf": 1, "tp_gsyih06_gy_cf": 1, "tp_gsyih07_gy_cf": 1, "tp_gsyih08_gy_cf": 1, "tp_gsyih09_gy_cf": 1, "tp_gsyih10_gy_cf": 1, "tp_gsyih11_gy_cf": 1, "tp_gsyih14_gy_cf": 1, "tp_gsyih15_gy_cf": 1, "tp_gsyih16_gy_cf": 1, "trigger": 4, "true": [0, 1, 5], "tune": 0, "tupl": 0, "turkei": 1, "type": 4, "typic": [4, 5], "u": 1, "under": 1, "unless": 1, "up": [0, 1], "updat": 1, "url": [0, 1], "us": [0, 1, 3, 5], "usag": [0, 2], "user": [1, 3, 4, 5], "util": 1, "valid": [3, 4], "valu": 5, "valueerror": [0, 3], "variou": 0, "version": 1, "via": [0, 5], "view": 2, "visit": 1, "visual": 1, "wai": 1, "weekli": 0, "what": 2, "when": [0, 1, 4], "where": [3, 4], "which": [0, 1, 4], "without": [0, 5], "year_to_year_differ": 0, "year_to_year_percent_chang": 0, "you": [1, 4], "your": 4, "your_api_key_her": 4, "yyyi": 0}, "titles": ["get_series Function", "Welcome to evdspy Documentation", "Welcome to evdspy\u2019s documentation!", "menu Function", "save Function", "setup Function"], "titleterms": {"": [1, 2], "api": 1, "behavior": 4, "code": 1, "command": 1, "content": 2, "detail": [3, 5], "disclaim": 1, "document": [1, 2], "error": 4, "evdspi": [1, 2], "exampl": [0, 1, 3, 4, 5], "featur": 1, "function": [0, 3, 4, 5], "get_seri": 0, "indic": 2, "instal": 1, "kei": 1, "learn": 1, "menu": [1, 3], "more": 1, "new": 1, "paramet": [0, 3, 4], "purpos": 5, "quick": 1, "rais": [0, 3], "return": [0, 3], "save": 4, "setup": 5, "signatur": 4, "sourc": 1, "start": 1, "tabl": 2, "usag": [1, 3, 4, 5], "view": 1, "welcom": [1, 2], "what": 1}})
\ No newline at end of file
diff --git a/docs/+1build/html/setup.html b/docs/+1build/html/setup.html
new file mode 100644
index 0000000..181f7bb
--- /dev/null
+++ b/docs/+1build/html/setup.html
@@ -0,0 +1,148 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
index 2dfa23b..2a65b3e 100644
Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ
diff --git a/docs/build/doctrees/get_series.doctree b/docs/build/doctrees/get_series.doctree
index 841b6b3..6596105 100644
Binary files a/docs/build/doctrees/get_series.doctree and b/docs/build/doctrees/get_series.doctree differ
diff --git a/docs/build/doctrees/menu.doctree b/docs/build/doctrees/menu.doctree
index ef88b54..bc6370f 100644
Binary files a/docs/build/doctrees/menu.doctree and b/docs/build/doctrees/menu.doctree differ
diff --git a/docs/build/doctrees/save.doctree b/docs/build/doctrees/save.doctree
index 5e009f5..bade66c 100644
Binary files a/docs/build/doctrees/save.doctree and b/docs/build/doctrees/save.doctree differ
diff --git a/docs/build/doctrees/setup.doctree b/docs/build/doctrees/setup.doctree
index 42e34b5..f29cda5 100644
Binary files a/docs/build/doctrees/setup.doctree and b/docs/build/doctrees/setup.doctree differ
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
index ef7dee1..0aaeb16 100644
--- a/docs/build/html/genindex.html
+++ b/docs/build/html/genindex.html
@@ -78,8 +78,39 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setup Function
+The setup function initializes the application environment by performing multiple preparatory steps essential for the application’s operation. This function encapsulates tasks such as configuring settings, initializing data structures, and preparing necessary resources.
Function Details
+Purpose
+The function is designed to:
+-
+
Initialize base settings and configurations via
SetupInitial().setup()
+Configure additional settings specific to the application setup phase with
start_setup_config(onsetup=True)
+Create initial data examples necessary for the application with
create_series_text_example(onsetup=True)
+
Usage
+The setup function is typically called at the beginning of the application’s lifecycle, before any other operations or user interactions occur.
Example Usage
+This function is generally used without arguments and does not return any value:
+from evdspy import setup
+setup()
+This call ensures that all initial configurations and setups are correctly executed, preparing the application for use.
+Index
+G
+| + |
M
+
|
+
S
+
|
+
|
+
- Welcome to evdspy Documentation
- get_series Function
- setup Function @@ -87,6 +88,75 @@
- +evdspy.get_series(index: str | tuple[Any, ...], start_date: str = '01-01-2000', end_date: str = '01-01-2100', frequency: str | int | None = None, formulas: str | tuple[str, int, ...] = None, aggregation: str | None = None, cache: bool = False, proxy: str | None = None, proxies: dict[str, str] | None = None, debug: bool = False, api_key: str | None = None) DataFrame | RequestConfig[source] +
Retrieves economic data series from the specified API and returns it as a pandas DataFrame. +Parameters +———- +index : str or tuple of str
++
+The identifier(s) for the data series to fetch. Can be a single string for one series or a tuple of strings for multiple series.
+-
+
- start_datestr, optional
The start date for the data retrieval in ‘DD-MM-YYYY’ format, by default calls default_start_date_fnc().
+
+- end_datestr, optional
The end date for the data retrieval in ‘DD-MM-YYYY’ format, by default calls default_end_date_fnc().
+
+- frequencystr, optional
The frequency at which data should be retrieved. +monthly | weekly | annually | semimonthly | semiannually | business
+
+- formulasstr or tuple of str, optional
The computation methods to apply to the data series +level | percentage_change | difference | year_to_year_percent_change | year_to_year_differences
+
+- aggregationstr or tuple of str, optional
The aggregation methods to apply to the data, similar to formulas. +avg |min | max | first | last | sum
+
+- cachebool, optional
If True, uses cached data when available to speed up the data retrieval process, by default False.
+
+- proxystr, optional
The URL of the proxy server to use for the requests, by default None.
+
+- proxiesdict, optional
A dictionary of proxies to use for the request, by default None.
+
+- debugbool, optional
If True, runs the function in debug mode, providing additional debug information without making a real API request, by default False.
+
+- api_keystr, optional
The API key required for accessing the data, by default None. +When it was given for the first time it will be saved to a file for the subsequent requests. +alternatively it may be saved by save(“APIKEY”) function or $ evdspy save [from console]
+
+
+ +Returns
+-
+
- pd.DataFrame
A pandas DataFrame containing the retrieved data series.
+
+
+ +Raises
+-
+
- ValueError
If an invalid API key is provided or required parameters are missing.
+
+
+ +Examples
+Basic usage: +# >>> template = “TP.ODEMGZS.BDTTOPLAM” +# >>> df = get_series(template, start_date=”01-01-2020”, end_date=”01-01-2021”, frequency=”monthly”) +# >>> print(df.head()) +# +# Using multiple indexes and cache: +# >>> indexes = (“TP.ODEMGZS.BDTTOPLAM”, “TP.ODEMGZS.ABD”) +# >>> df = get_series(indexes, start_date=”01-01-2020”, frequency=”monthly”, cache=True) +# >>> print(df.head()) +# +# Applying formulas and aggregation: +# >>> df = get_series(template, start_date=”01-01-2020”, formulas=”level”, aggregation=”sum”) +# >>> print(df.head())
+- pd.DataFrame
A pandas DataFrame containing the retrieved data series.
- ValueError
Raised if an invalid API key is provided or required parameters are missing.
- setup Function
-
+
setup()- Function Details
- Purpose
- Usage @@ -109,6 +111,7 @@
save()- Function Signature
- Parameters
- Behavior and Errors @@ -116,6 +119,7 @@
menu()- Function Details
- Parameters
- Returns diff --git a/docs/build/html/menu.html b/docs/build/html/menu.html index b98ccf7..a4f4c52 100644 --- a/docs/build/html/menu.html +++ b/docs/build/html/menu.html @@ -51,7 +51,11 @@
- setup Function
- save Function
- menu Function
-
-
- Function Details +
menu()
+- Function Details
-
+
menu()
+
- Parameters
- Returns
- Raises @@ -88,8 +92,18 @@
- get_series Function
- setup Function
- save Function
-
-
- Function Signature +
save()
+- Function Signature
-
+
save()
+
- Parameters
- Behavior and Errors
- Example Usage @@ -87,8 +91,18 @@
- Welcome to evdspy Documentation
- get_series Function
- setup Function
-
-
- Function Details +
setup()
+- Function Details
-
+
setup()
+
- Purpose
- Usage
- Example Usage @@ -87,8 +91,18 @@
setup Function
The
+ +setupfunction initializes the application environment by performing multiple preparatory steps essential for the application’s operation. This function encapsulates tasks such as configuring settings, initializing data structures, and preparing necessary resources.Function Details
+ +Purpose
diff --git a/docs/source/conf.py b/docs/source/conf.py index aa431d6..09221fa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,6 +6,8 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +html_build_dir = '../docs' + project = 'evdspy' copyright = '2024, Sermet Pekin' author = 'Sermet Pekin'
save Function
The
+ +savefunction is designed to save an API key into your application’s configuration or a designated storage mechanism. It ensures the API key is valid and prompts the user for input if the provided key is not valid or if no key is provided.Function Signature
+ +Parameters
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 6d56f42..3e38aa6 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Usage Examples": [[1, "api-usage-examples"]], "Behavior and Errors": [[4, "behavior-and-errors"]], "Contents:": [[2, null]], "Disclaimer": [[1, "disclaimer"]], "Example Usage": [[3, "example-usage"], [4, "example-usage"], [5, "example-usage"]], "Examples": [[0, "examples"]], "Function Details": [[3, "function-details"], [5, "function-details"]], "Function Signature": [[4, "function-signature"]], "Indices and tables": [[2, "indices-and-tables"]], "Installation": [[1, "installation"]], "Key Features": [[1, "key-features"]], "Learn More": [[1, "learn-more"]], "Menus and Commands": [[1, "menus-and-commands"]], "Parameters": [[0, "parameters"], [3, "parameters"], [4, "parameters"]], "Purpose": [[5, "purpose"]], "Quick Start": [[1, "quick-start"]], "Raises": [[0, "raises"], [3, "raises"]], "Returns": [[0, "returns"], [3, "returns"]], "Usage": [[5, "usage"]], "View Source Code": [[1, "view-source-code"]], "Welcome to evdspy Documentation": [[1, "welcome-to-evdspy-documentation"]], "Welcome to evdspy\u2019s documentation!": [[2, "welcome-to-evdspy-s-documentation"]], "What\u2019s New": [[1, "what-s-new"]], "get_series Function": [[0, "get-series-function"]], "menu Function": [[3, "menu-function"]], "save Function": [[4, "save-function"]], "setup Function": [[5, "setup-function"]]}, "docnames": ["get_series", "home", "index", "menu", "save", "setup"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["get_series.rst", "home.rst", "index.rst", "menu.rst", "save.rst", "setup.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 3, 4, 5], "0": 3, "01": 0, "2020": 0, "2021": 0, "A": [0, 3], "By": 0, "For": 1, "If": [0, 3, 4], "It": [1, 4], "The": [0, 1, 3, 4, 5], "To": 1, "abd": [0, 1], "access": [0, 1], "action": 3, "ad": 1, "addit": [0, 5], "affili": 1, "after": 3, "aggreg": [0, 1], "all": [1, 5], "an": [0, 1, 3, 4], "ani": 5, "annual": 0, "api": [0, 2, 4], "api_kei": [0, 4], "apikei": 0, "appli": 0, "applic": [1, 3, 4, 5], "ar": [0, 1, 5], "argument": 5, "attempt": 4, "automat": 1, "avail": [0, 3], "avg": [0, 1], "bank": 1, "base": 5, "basic": 0, "bdttoplam": [0, 1], "been": 1, "befor": 5, "begin": 5, "behavior": 2, "between": 3, "bool": 0, "both": 1, "busi": 0, "cach": [0, 1], "call": [0, 4, 5], "can": [0, 1], "capabl": 1, "case": 4, "cbrt": 1, "central": 1, "chang": 4, "check": 4, "check_apikey_and_then_sav": 4, "choic": 3, "choos": 3, "chosen": 3, "cli": 3, "code": 2, "com": 1, "command": [0, 2], "complex": 1, "compli": 1, "comput": 0, "configur": [1, 4, 5], "consol": 1, "contain": 0, "correctli": 5, "cover": 1, "creat": [1, 5], "create_series_text_exampl": 5, "crucial": 4, "data": [0, 1, 5], "datafram": 0, "date": 0, "dd": 0, "debug": [0, 1], "default": 0, "default_end_date_fnc": [0, 1], "default_start_date_fnc": [0, 1], "demonstr": 3, "deprec": 1, "design": [0, 4, 5], "detail": [1, 2], "develop": 1, "df": [0, 1], "dict": 0, "dictionari": 0, "differ": [0, 3], "directli": 4, "disclaim": 2, "displai": 3, "doe": 5, "dynam": 4, "econom": [0, 1], "ed": 1, "effici": 1, "encapsul": 5, "end": 0, "end_dat": [0, 1], "endors": 1, "enhanc": 1, "ensur": [1, 4, 5], "entri": 1, "environ": [4, 5], "error": 2, "essenti": 5, "evdspi": [0, 3, 5], "exampl": 2, "execut": 5, "explicitli": 1, "expos": 1, "extens": 0, "facilit": 1, "fals": [0, 1], "featur": 2, "fetch": 0, "file": 1, "final": 4, "fine": 0, "first": [0, 3], "folder": 1, "follow": 1, "format": 0, "formula": 0, "frequenc": [0, 1], "friendli": 1, "from": [0, 1, 3, 5], "function": [1, 2], "further": 4, "futur": 1, "gener": 5, "get": 1, "get_datagroup": 1, "get_seri": [1, 2], "github": 1, "group": 1, "guidelin": 1, "ha": 1, "handl": [1, 4], "head": 0, "header": 1, "help": 1, "here": [1, 3, 4], "how": [3, 4], "http": 1, "i": [0, 1, 3, 4, 5], "identifi": 0, "ignor": 1, "implement": 4, "import": [1, 3, 5], "includ": 0, "independ": 1, "index": [0, 1, 2, 3], "inform": [0, 1], "initi": [0, 4, 5], "input": [3, 4], "inquiri": 1, "instal": 2, "int": 3, "interact": [1, 3, 4, 5], "interfac": 1, "invalid": [0, 4], "involv": 4, "its": 1, "kei": [0, 2, 4], "last": 0, "law": 1, "lead": 4, "learn": 2, "level": 0, "licens": 1, "lifecycl": 5, "line": 0, "list": 3, "main": 1, "maintain": 1, "make": [0, 1], "manag": 1, "max": 0, "mechan": 4, "menu": 2, "method": [0, 4], "might": 4, "min": 0, "minim": 1, "miss": 0, "mit": 1, "mm": 0, "mode": 0, "modul": [1, 2], "monthli": [0, 1], "more": 2, "move": 1, "multipl": [0, 5], "necessari": [4, 5], "new": 2, "none": [0, 4], "note": 1, "now": 1, "occur": 5, "odemgz": [0, 1], "offici": 1, "one": 0, "onsetup": 5, "open": 1, "oper": [4, 5], "optim": 1, "option": [0, 1, 3, 4], "other": 5, "our": 1, "output": 1, "page": 2, "panda": 0, "paramet": [1, 2], "particularli": 4, "pass": 4, "pd": 0, "percentage_chang": 0, "perform": 5, "phase": 5, "pip": 1, "pleas": 1, "prepar": [1, 5], "preparatori": 5, "presum": 4, "print": [0, 1, 3], "process": [0, 1], "project": 1, "prompt": 4, "provid": [0, 1, 4], "proxi": 0, "purpos": 2, "python": 1, "quick": 2, "rais": 2, "real": 0, "redund": 1, "refer": 1, "repo": 1, "repositori": 1, "repres": 3, "republ": 1, "request": [0, 1, 4], "requir": [0, 3, 4], "resourc": 5, "result": 1, "retriev": [0, 1], "return": [2, 5], "run": [0, 1], "save": [0, 1, 2], "scenario": 4, "search": 2, "section": 1, "secur": [1, 4], "select": 3, "semiannu": 0, "semimonthli": 0, "sensit": 1, "seri": [0, 1], "sermetpekin": 1, "server": 0, "servic": 1, "set": [1, 4, 5], "set_apikey_input": 4, "setup": [1, 2], "setupiniti": 5, "should": [0, 1, 4], "signatur": 2, "simpl": 3, "simpli": 1, "simplifi": 1, "singl": 0, "sourc": 2, "specif": 5, "specifi": 0, "speed": [0, 1], "start": [0, 2], "start_dat": [0, 1], "start_setup_config": 5, "step": [4, 5], "storag": 4, "str": [0, 3, 4], "string": [0, 3, 4], "structur": [1, 5], "subsequ": [1, 4], "sum": 0, "task": 5, "templat": [0, 1], "termin": 1, "textual": 1, "thi": [0, 1, 3, 4, 5], "three": 3, "through": [1, 4], "tool": 1, "tp": [0, 1], "tp_gsyih01_gy_cf": 1, "tp_gsyih02_gy_cf": 1, "tp_gsyih03_gy_cf": 1, "tp_gsyih04_gy_cf": 1, "tp_gsyih05_gy_cf": 1, "tp_gsyih06_gy_cf": 1, "tp_gsyih07_gy_cf": 1, "tp_gsyih08_gy_cf": 1, "tp_gsyih09_gy_cf": 1, "tp_gsyih10_gy_cf": 1, "tp_gsyih11_gy_cf": 1, "tp_gsyih14_gy_cf": 1, "tp_gsyih15_gy_cf": 1, "tp_gsyih16_gy_cf": 1, "trigger": 4, "true": [0, 1, 5], "tune": 0, "tupl": 0, "turkei": 1, "type": 4, "typic": [4, 5], "u": 1, "under": 1, "unless": 1, "up": [0, 1], "updat": 1, "url": [0, 1], "us": [0, 1, 3, 5], "usag": [0, 2], "user": [1, 3, 4, 5], "util": 1, "valid": [3, 4], "valu": 5, "valueerror": [0, 3], "variou": 0, "version": 1, "via": [0, 5], "view": 2, "visit": 1, "visual": 1, "wai": 1, "weekli": 0, "what": 2, "when": [0, 1, 4], "where": [3, 4], "which": [0, 1, 4], "without": [0, 5], "year_to_year_differ": 0, "year_to_year_percent_chang": 0, "you": [1, 4], "your": 4, "your_api_key_her": 4, "yyyi": 0}, "titles": ["get_series Function", "Welcome to evdspy Documentation", "Welcome to evdspy\u2019s documentation!", "menu Function", "save Function", "setup Function"], "titleterms": {"": [1, 2], "api": 1, "behavior": 4, "code": 1, "command": 1, "content": 2, "detail": [3, 5], "disclaim": 1, "document": [1, 2], "error": 4, "evdspi": [1, 2], "exampl": [0, 1, 3, 4, 5], "featur": 1, "function": [0, 3, 4, 5], "get_seri": 0, "indic": 2, "instal": 1, "kei": 1, "learn": 1, "menu": [1, 3], "more": 1, "new": 1, "paramet": [0, 3, 4], "purpos": 5, "quick": 1, "rais": [0, 3], "return": [0, 3], "save": 4, "setup": 5, "signatur": 4, "sourc": 1, "start": 1, "tabl": 2, "usag": [1, 3, 4, 5], "view": 1, "welcom": [1, 2], "what": 1}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Usage Examples": [[1, "api-usage-examples"]], "Behavior and Errors": [[4, "behavior-and-errors"]], "Contents:": [[2, null]], "Disclaimer": [[1, "disclaimer"]], "Example Usage": [[3, "example-usage"], [4, "example-usage"], [5, "example-usage"]], "Examples": [[0, "examples"], [0, "id5"]], "Function Details": [[3, "function-details"], [5, "function-details"]], "Function Signature": [[4, "function-signature"]], "Indices and tables": [[2, "indices-and-tables"]], "Installation": [[1, "installation"]], "Key Features": [[1, "key-features"]], "Learn More": [[1, "learn-more"]], "Menus and Commands": [[1, "menus-and-commands"]], "Parameters": [[0, "parameters"], [3, "parameters"], [4, "parameters"]], "Purpose": [[5, "purpose"]], "Quick Start": [[1, "quick-start"]], "Raises": [[0, "raises"], [0, "id4"], [3, "raises"]], "Returns": [[0, "returns"], [0, "id3"], [3, "returns"]], "Usage": [[5, "usage"]], "View Source Code": [[1, "view-source-code"]], "Welcome to evdspy Documentation": [[1, "welcome-to-evdspy-documentation"]], "Welcome to evdspy\u2019s documentation!": [[2, "welcome-to-evdspy-s-documentation"]], "What\u2019s New": [[1, "what-s-new"]], "get_series Function": [[0, "get-series-function"]], "menu Function": [[3, "menu-function"]], "save Function": [[4, "save-function"]], "setup Function": [[5, "setup-function"]]}, "docnames": ["get_series", "home", "index", "menu", "save", "setup"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["get_series.rst", "home.rst", "index.rst", "menu.rst", "save.rst", "setup.rst"], "indexentries": {"get_series() (in module evdspy)": [[0, "evdspy.get_series", false]], "menu() (in module evdspy)": [[3, "evdspy.menu", false], [3, "id0", false]], "save() (in module evdspy)": [[4, "evdspy.save", false], [4, "id0", false]], "setup() (in module evdspy)": [[5, "evdspy.setup", false], [5, "id0", false]]}, "objects": {"evdspy": [[0, 0, 1, "", "get_series"], [3, 0, 1, "id0", "menu"], [4, 0, 1, "id0", "save"], [5, 0, 1, "id0", "setup"]]}, "objnames": {"0": ["py", "function", "Python function"]}, "objtypes": {"0": "py:function"}, "terms": {"": [0, 3, 4, 5], "0": 3, "01": 0, "2000": 0, "2020": 0, "2021": 0, "2100": 0, "A": [0, 3], "By": 0, "For": 1, "If": [0, 3, 4], "It": [1, 4], "The": [0, 1, 3, 4, 5], "To": 1, "abd": [0, 1], "access": [0, 1], "action": 3, "ad": 1, "addit": [0, 5], "affili": 1, "after": 3, "aggreg": [0, 1], "all": [1, 5], "altern": 0, "an": [0, 1, 3, 4], "ani": [0, 5], "annual": 0, "api": [0, 2, 4], "api_kei": [0, 4], "apikei": 0, "appli": 0, "applic": [1, 3, 4, 5], "ar": [0, 1, 5], "arg": [3, 4], "argument": 5, "attempt": 4, "automat": 1, "avail": [0, 3], "avg": [0, 1], "bank": 1, "base": 5, "basic": 0, "bdttoplam": [0, 1], "been": 1, "befor": 5, "begin": 5, "behavior": 2, "between": 3, "bool": 0, "both": 1, "busi": 0, "cach": [0, 1], "call": [0, 4, 5], "can": [0, 1], "capabl": 1, "case": 4, "cbrt": 1, "central": 1, "chang": 4, "check": 4, "check_apikey_and_then_sav": 4, "choic": 3, "choos": 3, "chosen": 3, "cli": 3, "code": 2, "com": 1, "command": [0, 2], "complex": 1, "compli": 1, "comput": 0, "configur": [1, 4, 5], "consol": [0, 1], "contain": 0, "correctli": 5, "cover": 1, "creat": [1, 5], "create_series_text_exampl": 5, "crucial": 4, "data": [0, 1, 5], "datafram": 0, "date": 0, "dd": 0, "debug": [0, 1], "default": 0, "default_end_date_fnc": [0, 1], "default_start_date_fnc": [0, 1], "demonstr": 3, "deprec": 1, "design": [0, 4, 5], "detail": [1, 2], "develop": 1, "df": [0, 1], "dict": 0, "dictionari": 0, "differ": [0, 3], "directli": 4, "disclaim": 2, "displai": 3, "doe": 5, "dynam": 4, "econom": [0, 1], "ed": 1, "effici": 1, "encapsul": 5, "end": 0, "end_dat": [0, 1], "endors": 1, "enhanc": 1, "ensur": [1, 4, 5], "entri": 1, "environ": [4, 5], "error": 2, "essenti": 5, "evdspi": [0, 3, 4, 5], "exampl": 2, "execut": 5, "explicitli": 1, "expos": 1, "extens": 0, "facilit": 1, "fals": [0, 1], "featur": 2, "fetch": 0, "file": [0, 1], "final": 4, "fine": 0, "first": [0, 3], "folder": 1, "follow": 1, "format": 0, "formula": 0, "frequenc": [0, 1], "friendli": 1, "from": [0, 1, 3, 5], "function": [1, 2], "further": 4, "futur": 1, "gener": 5, "get": 1, "get_datagroup": 1, "get_seri": [1, 2], "github": 1, "given": 0, "group": 1, "guidelin": 1, "ha": 1, "handl": [1, 4], "head": 0, "header": 1, "help": 1, "here": [1, 3, 4], "how": [3, 4], "http": 1, "i": [0, 1, 3, 4, 5], "identifi": 0, "ignor": 1, "implement": 4, "import": [1, 3, 5], "includ": 0, "independ": 1, "index": [0, 1, 2, 3], "inform": [0, 1], "initi": [0, 4, 5], "input": [3, 4], "inquiri": 1, "instal": 2, "int": [0, 3], "interact": [1, 3, 4, 5], "interfac": 1, "invalid": [0, 4], "involv": 4, "its": 1, "kei": [0, 2, 4], "kw": 3, "last": 0, "law": 1, "lead": 4, "learn": 2, "level": 0, "licens": 1, "lifecycl": 5, "line": 0, "list": 3, "mai": 0, "main": 1, "maintain": 1, "make": [0, 1], "manag": 1, "max": 0, "mechan": 4, "menu": 2, "method": [0, 4], "might": 4, "min": 0, "minim": 1, "miss": 0, "mit": 1, "mm": 0, "mode": 0, "modul": [1, 2], "monthli": [0, 1], "more": 2, "move": 1, "multipl": [0, 5], "necessari": [4, 5], "new": 2, "none": [0, 4], "note": 1, "now": 1, "occur": 5, "odemgz": [0, 1], "offici": 1, "one": 0, "onsetup": 5, "open": 1, "oper": [4, 5], "optim": 1, "option": [0, 1, 3, 4], "other": 5, "our": 1, "output": 1, "page": 2, "panda": 0, "paramet": [1, 2], "particularli": 4, "pass": 4, "pd": 0, "percentage_chang": 0, "perform": 5, "phase": 5, "pip": 1, "pleas": 1, "prepar": [1, 5], "preparatori": 5, "presum": 4, "print": [0, 1, 3], "process": [0, 1], "project": 1, "prompt": 4, "provid": [0, 1, 4], "proxi": 0, "purpos": 2, "python": 1, "quick": 2, "rais": 2, "real": 0, "redund": 1, "refer": 1, "repo": 1, "repositori": 1, "repres": 3, "republ": 1, "request": [0, 1, 4], "requestconfig": 0, "requir": [0, 3, 4], "resourc": 5, "result": 1, "retriev": [0, 1], "return": [2, 5], "run": [0, 1], "save": [0, 1, 2], "scenario": 4, "search": 2, "section": 1, "secur": [1, 4], "select": 3, "semiannu": 0, "semimonthli": 0, "sensit": 1, "seri": [0, 1], "sermetpekin": 1, "server": 0, "servic": 1, "set": [1, 4, 5], "set_apikey_input": 4, "setup": [1, 2], "setupiniti": 5, "should": [0, 1, 4], "signatur": 2, "similar": 0, "simpl": 3, "simpli": 1, "simplifi": 1, "singl": 0, "sourc": [0, 2, 3, 4, 5], "specif": 5, "specifi": 0, "speed": [0, 1], "start": [0, 2], "start_dat": [0, 1], "start_setup_config": 5, "step": [4, 5], "storag": 4, "str": [0, 3, 4], "string": [0, 3, 4], "structur": [1, 5], "subsequ": [0, 1, 4], "sum": 0, "task": 5, "templat": [0, 1], "termin": 1, "textual": 1, "thi": [0, 1, 3, 4, 5], "three": 3, "through": [1, 4], "time": 0, "tool": 1, "tp": [0, 1], "tp_gsyih01_gy_cf": 1, "tp_gsyih02_gy_cf": 1, "tp_gsyih03_gy_cf": 1, "tp_gsyih04_gy_cf": 1, "tp_gsyih05_gy_cf": 1, "tp_gsyih06_gy_cf": 1, "tp_gsyih07_gy_cf": 1, "tp_gsyih08_gy_cf": 1, "tp_gsyih09_gy_cf": 1, "tp_gsyih10_gy_cf": 1, "tp_gsyih11_gy_cf": 1, "tp_gsyih14_gy_cf": 1, "tp_gsyih15_gy_cf": 1, "tp_gsyih16_gy_cf": 1, "trigger": 4, "true": [0, 1, 5], "tune": 0, "tupl": 0, "turkei": 1, "type": 4, "typic": [4, 5], "u": 1, "under": 1, "unless": 1, "up": [0, 1], "updat": 1, "url": [0, 1], "us": [0, 1, 3, 5], "usag": [0, 2], "user": [1, 3, 4, 5], "util": 1, "valid": [3, 4], "valu": 5, "valueerror": [0, 3], "variou": 0, "version": 1, "via": [0, 5], "view": 2, "visit": 1, "visual": 1, "wa": 0, "wai": 1, "weekli": 0, "what": 2, "when": [0, 1, 4], "where": [3, 4], "which": [0, 1, 4], "without": [0, 5], "year_to_year_differ": 0, "year_to_year_percent_chang": 0, "you": [1, 4], "your": 4, "your_api_key_her": 4, "yyyi": 0}, "titles": ["get_series Function", "Welcome to evdspy Documentation", "Welcome to evdspy\u2019s documentation!", "menu Function", "save Function", "setup Function"], "titleterms": {"": [1, 2], "api": 1, "behavior": 4, "code": 1, "command": 1, "content": 2, "detail": [3, 5], "disclaim": 1, "document": [1, 2], "error": 4, "evdspi": [1, 2], "exampl": [0, 1, 3, 4, 5], "featur": 1, "function": [0, 3, 4, 5], "get_seri": 0, "indic": 2, "instal": 1, "kei": 1, "learn": 1, "menu": [1, 3], "more": 1, "new": 1, "paramet": [0, 3, 4], "purpos": 5, "quick": 1, "rais": [0, 3], "return": [0, 3], "save": 4, "setup": 5, "signatur": 4, "sourc": 1, "start": 1, "tabl": 2, "usag": [1, 3, 4, 5], "view": 1, "welcom": [1, 2], "what": 1}}) \ No newline at end of file diff --git a/docs/build/html/setup.html b/docs/build/html/setup.html index 181f7bb..04bc69b 100644 --- a/docs/build/html/setup.html +++ b/docs/build/html/setup.html @@ -50,7 +50,11 @@
menu Function
The
+menufunction displays a list of selectable options to the user and returns the index of the chosen option. This function is useful in CLI applications where user interaction is required to choose between different actions.-
+
+
Function Details
+ +Parameters
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 2fa2f8c..aee4288 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/save.html b/docs/build/html/save.html index 9af1fb7..1631fbd 100644 --- a/docs/build/html/save.html +++ b/docs/build/html/save.html @@ -51,7 +51,11 @@
Welcome to evdspy’s documentation!save Function
-
+
Welcome to evdspy’s documentation!menu Function
-
+
get_series Function
The get_series function is designed to fetch economic data series from a specified API and return it formatted as a pandas DataFrame, making extensive use of various parameters to fine-tune the data retrieval process.
-
+
Parameters
-
@@ -114,22 +184,22 @@
Parameters
-Returns
+
+Returns
-
-Raises
+
+Raises
-
-Examples
+
+Examples
Basic usage:
index = "TP.ODEMGZS.BDTTOPLAM"
df = get_series(index, start_date="01-01-2020", end_date="01-01-2021", frequency="monthly")
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
index f35bd3f..06c0d0a 100644
--- a/docs/build/html/index.html
+++ b/docs/build/html/index.html
@@ -95,13 +95,15 @@ Welcome to evdspy’s documentation!get_series Function
Returns
Raises
+Raises
Examples
+Examples
Basic usage:
index = "TP.ODEMGZS.BDTTOPLAM"
df = get_series(index, start_date="01-01-2020", end_date="01-01-2021", frequency="monthly")
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
index f35bd3f..06c0d0a 100644
--- a/docs/build/html/index.html
+++ b/docs/build/html/index.html
@@ -95,13 +95,15 @@ Welcome to evdspy’s documentation!get_series Function