mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 16:32:10 +00:00
[Feature] Add openbb-platform-api To Main pyproject.toml (#6818)
* add openbb-platform-api to pyproject.toml * static files * fix test
This commit is contained in:
Danglewood
143
openbb_platform/openbb/assets/reference.json
vendored
143
openbb_platform/openbb/assets/reference.json
vendored
@@ -5523,16 +5523,20 @@
|
||||
],
|
||||
"fred": [
|
||||
{
|
||||
"name": "is_release",
|
||||
"type": "bool",
|
||||
"description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.",
|
||||
"default": false,
|
||||
"name": "search_type",
|
||||
"type": "Literal['full_text', 'series_id', 'release']",
|
||||
"description": "The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.",
|
||||
"default": "full_text",
|
||||
"optional": true,
|
||||
"choices": null
|
||||
"choices": [
|
||||
"full_text",
|
||||
"series_id",
|
||||
"release"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "release_id",
|
||||
"type": "Union[int, str]",
|
||||
"type": "Annotated[int, Ge(ge=0)]",
|
||||
"description": "A specific release ID to target.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
@@ -5540,7 +5544,7 @@
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"type": "int",
|
||||
"type": "Annotated[int, Ge(ge=0)]",
|
||||
"description": "The number of data entries to return. (1-1000)",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
@@ -5549,11 +5553,41 @@
|
||||
{
|
||||
"name": "offset",
|
||||
"type": "Annotated[int, Ge(ge=0)]",
|
||||
"description": "Offset the results in conjunction with limit.",
|
||||
"description": "Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.",
|
||||
"default": 0,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "order_by",
|
||||
"type": "Literal['search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity']",
|
||||
"description": "Order the results by a specific attribute. The default is 'observation_end'.",
|
||||
"default": "observation_end",
|
||||
"optional": true,
|
||||
"choices": [
|
||||
"search_rank",
|
||||
"series_id",
|
||||
"title",
|
||||
"units",
|
||||
"frequency",
|
||||
"seasonal_adjustment",
|
||||
"realtime_start",
|
||||
"realtime_end",
|
||||
"last_updated",
|
||||
"observation_start",
|
||||
"observation_end",
|
||||
"popularity",
|
||||
"group_popularity"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"type": "Literal['asc', 'desc']",
|
||||
"description": "Sort the 'order_by' item in ascending or descending order. The default is 'desc'.",
|
||||
"default": "desc",
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "filter_variable",
|
||||
"type": "Literal['frequency', 'units', 'seasonal_adjustment']",
|
||||
@@ -5565,7 +5599,7 @@
|
||||
{
|
||||
"name": "filter_value",
|
||||
"type": "str",
|
||||
"description": "String value to filter the variable by. Used in conjunction with filter_variable.",
|
||||
"description": "String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
@@ -5573,7 +5607,7 @@
|
||||
{
|
||||
"name": "tag_names",
|
||||
"type": "Union[str, List[str]]",
|
||||
"description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' Multiple items allowed for provider(s): fred.",
|
||||
"description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
@@ -5581,7 +5615,7 @@
|
||||
{
|
||||
"name": "exclude_tag_names",
|
||||
"type": "Union[str, List[str]]",
|
||||
"description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. Multiple items allowed for provider(s): fred.",
|
||||
"description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
@@ -5629,7 +5663,7 @@
|
||||
"standard": [
|
||||
{
|
||||
"name": "release_id",
|
||||
"type": "Union[int, str]",
|
||||
"type": "str",
|
||||
"description": "The release ID for queries.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
@@ -5643,6 +5677,22 @@
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "series_group",
|
||||
"type": "str",
|
||||
"description": "The series group ID of the series. This value is used to query for regional data.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "region_type",
|
||||
"type": "str",
|
||||
"description": "The region type of the series.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "str",
|
||||
@@ -5731,6 +5781,38 @@
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "popularity",
|
||||
"type": "int",
|
||||
"description": "Popularity of the series",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "group_popularity",
|
||||
"type": "int",
|
||||
"description": "Group popularity of the release",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "realtime_start",
|
||||
"type": "date",
|
||||
"description": "The realtime start date of the series.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "realtime_end",
|
||||
"type": "date",
|
||||
"description": "The realtime end date of the series.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "notes",
|
||||
"type": "str",
|
||||
@@ -5756,40 +5838,7 @@
|
||||
"choices": null
|
||||
}
|
||||
],
|
||||
"fred": [
|
||||
{
|
||||
"name": "popularity",
|
||||
"type": "int",
|
||||
"description": "Popularity of the series",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "group_popularity",
|
||||
"type": "int",
|
||||
"description": "Group popularity of the release",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "region_type",
|
||||
"type": "str",
|
||||
"description": "The region type of the series.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
},
|
||||
{
|
||||
"name": "series_group",
|
||||
"type": "Union[int, str]",
|
||||
"description": "The series group ID of the series. This value is used to query for regional data.",
|
||||
"default": null,
|
||||
"optional": true,
|
||||
"choices": null
|
||||
}
|
||||
]
|
||||
"fred": []
|
||||
},
|
||||
"model": "FredSearch"
|
||||
},
|
||||
@@ -39292,4 +39341,4 @@
|
||||
"description": "Financial market regulators data."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2257,9 +2257,9 @@ class ROUTER_economy(Container):
|
||||
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred.
|
||||
search_type : Literal['full_text', 'series_id', 'release']
|
||||
The type of search to perform. Automatically set to 'release' when a 'release_id' is provided. (provider: fred)
|
||||
release_id : Optional[Union[int, str]]
|
||||
release_id : Optional[Annotated[int, Ge(ge=0)]]
|
||||
A specific release ID to target. (provider: fred)
|
||||
limit : Optional[int]
|
||||
limit : Optional[Annotated[int, Ge(ge=0)]]
|
||||
The number of data entries to return. (1-1000) (provider: fred)
|
||||
offset : Optional[Annotated[int, Ge(ge=0)]]
|
||||
Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'. (provider: fred)
|
||||
|
||||
2094
openbb_platform/poetry.lock
generated
vendored
2094
openbb_platform/poetry.lock
generated
vendored
File diff suppressed because it is too large
Load Diff
1
openbb_platform/pyproject.toml
vendored
1
openbb_platform/pyproject.toml
vendored
@@ -10,6 +10,7 @@ packages = [{ include = "openbb" }]
|
||||
[tool.poetry.dependencies]
|
||||
python = ">=3.9,<3.13"
|
||||
openbb-core = "^1.3.4"
|
||||
openbb-platform-api = "^1.0.2"
|
||||
|
||||
openbb-benzinga = "^1.3.3"
|
||||
openbb-bls = "^1.0.1"
|
||||
|
||||
@@ -42,10 +42,11 @@ def test_extension_map():
|
||||
req_ext = load_req_ext(Path(this_dir, "..", "pyproject.toml"))
|
||||
|
||||
for ext in req_ext:
|
||||
assert ext in ext_map, (
|
||||
f"Extension '{ext}' is required in pyproject.toml but is not built, install"
|
||||
" it and rebuild or remove it from mandatory requirements in pyproject.toml"
|
||||
)
|
||||
if ext != "platform_api":
|
||||
assert ext in ext_map, (
|
||||
f"Extension '{ext}' is required in pyproject.toml but is not built, install"
|
||||
" it and rebuild or remove it from mandatory requirements in pyproject.toml"
|
||||
)
|
||||
|
||||
for name, version in ext_map.items():
|
||||
assert name in req_ext, (
|
||||
|
||||
Reference in New Issue
Block a user