fix: example usage for the Python API

kedro-org · Sep 30, 2024 · 898566b · 898566b
1 parent 059ff89
commit 898566b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/kedro-datasets/kedro_datasets_experimental/pandas/delta_sharing_dataset.py b/kedro-datasets/kedro_datasets_experimental/pandas/delta_sharing_dataset.py
@@ -38,8 +38,7 @@ class DeltaSharingDataset(AbstractDataset):
 
     .. code-block:: pycon
 
-        >>> from kedro_datasets import DeltaSharingDataset
-        >>> import pandas as pd
+        >>> from kedro_datasets_experimental.pandas import DeltaSharingDataset
         >>>
         >>> credentials = {
         ...     "profile_file": "conf/local/config.share"

diff --git a/kedro-datasets/test.py b/kedro-datasets/test.py
@@ -0,0 +1,20 @@
+from kedro_datasets_experimental.pandas import DeltaSharingDataset
+
+credentials = {
+    "profile_file": "open-datasets.share"
+    }
+
+load_args = {
+    "limit": 10,
+}
+
+dataset = DeltaSharingDataset(
+    share="delta_sharing",
+    schema="default",
+    table="nyctaxi_2019",
+    credentials=credentials,
+    load_args=load_args
+)
+
+data = dataset.load()
+print(data)