Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update docs in Business Core prefect task #1109

Merged
merged 2 commits into from
Dec 4, 2024
Merged

📝 Update docs in Business Core prefect task #1109

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ecaeaf
🩹 Update docs and task params
judynah Dec 2, 2024
583471f
♻️ Added blank line
judynah Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/viadot/orchestration/prefect/tasks/business_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Task for downloading data from Business Core API to a Parquet file."""
"""Task for downloading data from Business Core API to a pandas DataFrame."""

from typing import Any

Expand All @@ -14,18 +14,16 @@

@task(retries=3, retry_delay_seconds=10, timeout_seconds=60 * 60 * 3)
def business_core_to_df(
path: str | None = None,
url: str | None = None,
filters: dict[str, Any] | None = None,
credentials_secret: str | None = None,
config_key: str | None = None,
if_empty: str = "skip",
verify: bool = True,
) -> DataFrame:
"""Download data from Business Core API to a Parquet file.
"""Download data from Business Core API to a pandas DataFrame.

Args:
path (str, required): Path where to save the Parquet file. Defaults to None.
url (str, required): Base url to the view in Business Core API. Defaults to
None.
filters (dict[str, Any], optional): Filters in form of dictionary. Available
Expand All @@ -51,7 +49,6 @@ def business_core_to_df(

bc = BusinessCore(
url=url,
path=path,
credentials=credentials,
config_key=config_key,
filters=filters,
Expand Down