Repository: Teradata/feast-teradata (language: python)

Issue:
Improve getting started / readme



Discussion / hints:

Fix patch:
diff --git a/.github/workflows/cd-release.yml b/.github/workflows/cd-release.yml
index b7f70b0..45754cb 100644
--- a/.github/workflows/cd-release.yml
+++ b/.github/workflows/cd-release.yml
@@ -19,7 +19,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements-dev.txt
       - name: Bump version
         shell: bash
         run: |
diff --git a/README.md b/README.md
index 8c7d664..73aa5b4 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ The `feast-teradata` library adds support for Teradata as
 - OfflineStore 
 - OnlineStore
 
-Additional, the using Teradata as the registry is already supported via the `registry_type: sql` and included in our examples. This means that everything is located in Teradata. However, depending on the requirements, installation, etc, this can be mixed and matched with other systems as appropriate.  
+Additional, using Teradata as the registry (catalog) is already supported via the `registry_type: sql` and included in our examples. This means that everything is located in Teradata. However, depending on the requirements, installation, etc, this can be mixed and matched with other systems as appropriate.  
 
 ## Getting Started
 
@@ -27,6 +27,7 @@ feast-td init-repo
 
 This will then prompt you for the required information for the Teradata system and upload the example dataset. Let's assume you used the repo name `demo` when running the above command. You can find the repository files along with a file called `test_workflow.py`. Running this `test_workflow.py` will execute a complete workflow for feast with Teradata as the Registry, OfflineStore and OnlineStore. 
 
+
 ```
 demo/
     feature_repo/
@@ -35,13 +36,64 @@ demo/
     test_workflow.py
 ```
 
+
+From within the `demo/feature_repo` directory, execute the following feast command to apply (import/update) the repo definition into the registry. You will be able to see the registry metadata tables in the teradata database after running this command.
+
+
+```bash
+feast apply
+```
+
+
+To see the registry information in the feast ui, run the following command. Note the --registry_ttl_sec is important as by default it polls every 5 seconds. 
+
 ```bash
-python demo/test_workflow.py
+feast ui --registry_ttl_sec=120
 ```
 
 
+## Example Usage
+
+Now, lets batch read some features for training, using only entities (population) for which we have seen an event for in the last `60` days. The predicates (filter) used can be on anything that is relevant for the entity (population) selection for the given training dataset. The `event_timestamp` is only for example purposes.
+
+
+```python
+from feast import FeatureStore
+
+
+store = FeatureStore(repo_path="feature_repo")
+
+training_df = store.get_historical_features(
+    entity_df=f"""
+            SELECT
+                driver_id,
+                event_timestamp
+            FROM demo_feast_driver_hourly_stats
+            WHERE event_timestamp BETWEEN (CURRENT_TIMESTAMP - INTERVAL '60' DAY) AND CURRENT_TIMESTAMP
+        """,
+    features=[
+        "driver_hourly_stats:conv_rate",
+        "driver_hourly_stats:acc_rate",
+        "driver_hourly_stats:avg_daily_trips"
+    ],
+).to_df()
+print(training_df.head())
+```
+
+
+The `feast-teradata` library allows you to use the complete set of feast APIs and functionality. Please refer to the official feast [quickstart](https://docs.feast.dev/getting-started/quickstart) for more details on the various things you can do. Additionally, if you want to see a complete (but not real-world), end-to-end example workflow example, see the `demo/test_workflow.py` script. This is used for testing the complete feast functionality.
+
+
 ## Release Notes
 
+### 1.0.1
+
+- Doc: Improve README with better getting started information. 
+- Fix: Remove pytest from requirements.txt
+- Fix: Set minimum python version to 3.8 due to feast dependency on pandas>=1.4.3
+- Fix: Updated feast-td types conversion
+
+
 ### 1.0.0
 
 - Feature: Initial implementation of feast-teradata library
diff --git a/requirements_dev.txt b/requirements-dev.txt
similarity index 100%
rename from requirements_dev.txt
rename to requirements-dev.txt
diff --git a/requirements.txt b/requirements.txt
index b3c8ce7..41f1d62 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,2 @@
 teradataml>=17.0.0.4
 feast==0.26.0
-pytest
diff --git a/setup.py b/setup.py
index 8489336..44949d2 100644
--- a/setup.py
+++ b/setup.py
@@ -14,7 +14,7 @@
     url="https://github.com/Teradata/feast-teradata",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     packages=find_packages(exclude=('tests',)),
     package_data={
         'feast_teradata.cli': [


Test patch:
diff --git a/.github/workflows/ci-integeration-tests.yml b/.github/workflows/ci-integeration-tests.yml
index 3431c28..32cb97e 100644
--- a/.github/workflows/ci-integeration-tests.yml
+++ b/.github/workflows/ci-integeration-tests.yml
@@ -66,7 +66,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements-dev.txt
           # install timeout command
           export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=yes
           export HOMEBREW_NO_INSTALL_CLEANUP=yes
diff --git a/feast_teradata/cli/template/teradata/test_workflow.py b/feast_teradata/cli/template/teradata/test_workflow.py
index 8b2dc4d..66c9ffc 100644
--- a/feast_teradata/cli/template/teradata/test_workflow.py
+++ b/feast_teradata/cli/template/teradata/test_workflow.py
@@ -1,9 +1,9 @@
 import random
 import subprocess
-from datetime import datetime, timedelta
-
 import pandas as pd
 import yaml
+
+from datetime import datetime, timedelta
 from pytz import utc
 
 from feast import FeatureStore