python(feat): Sift Client Ingestion (#370)

Author: nathan-sift

.github/workflows/python_ci.yaml

@@ -17,7 +17,9 @@ jobs:
         working-directory: python
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Set up Python
         uses: actions/setup-python@v2

python/docs/examples/ingestion.ipynb

@@ -0,0 +1,102 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0b202351",
+   "metadata": {},
+   "source": [
+    "# Sift Client Ingestion Basic Example\n",
+    "\n",
+    "This notebook demonstrates some examples features of SiftClient ingestion\n",
+    "- Initializing the Sift client\n",
+    "- Creating an ingestion config\n",
+    "- Creating a run\n",
+    "- Creating and sending flows\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "02268d76",
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "import asyncio\n",
+    "import random\n",
+    "import time\n",
+    "from datetime import datetime, timezone\n",
+    "\n",
+    "from sift_client import SiftClient, SiftConnectionConfig\n",
+    "from sift_client.sift_types import (\n",
+    "    ChannelConfig,\n",
+    "    ChannelDataType,\n",
+    "    FlowConfig,\n",
+    "    IngestionConfigCreate,\n",
+    "    RunCreate,\n",
+    ")\n",
+    "\n",
+    "\n",
+    "async def main():\n",
+    "    connection_config = SiftConnectionConfig(\n",
+    "        api_key=\"my_api_key\",\n",
+    "        grpc_url=\"sift_grpc_url\",\n",
+    "        rest_url=\"sift_rest_url\",\n",
+    "    )\n",
+    "\n",
+    "    client = SiftClient(connection_config=connection_config)\n",
+    "\n",
+    "    # Ingestion configs are created using SiftClient types\n",
+    "    ingestion_config = IngestionConfigCreate(\n",
+    "        asset_name=\"sift_rover_1\",\n",
+    "        flows=[\n",
+    "            FlowConfig(\n",
+    "                name=\"onboard_sensors\",\n",
+    "                channels=[\n",
+    "                    ChannelConfig(name=\"motor_temp\", unit=\"C\", data_type=ChannelDataType.DOUBLE),\n",
+    "                    ChannelConfig(\n",
+    "                        name=\"tank_pressure\", unit=\"kPa\", data_type=ChannelDataType.DOUBLE\n",
+    "                    ),\n",
+    "                ],\n",
+    "            )\n",
+    "        ],\n",
+    "    )\n",
+    "\n",
+    "    run = RunCreate(name=\"sift_rover-\" + str(int(time.time())))\n",
+    "\n",
+    "    async with await client.async_.ingestion.create_ingestion_config_streaming_client(\n",
+    "        ingestion_config=ingestion_config,\n",
+    "        run=run,\n",
+    "    ) as ingest_client:\n",
+    "        while True:\n",
+    "            # Flows can be generated easily from the ingest client\n",
+    "            flow_config = ingest_client.get_flow_config(flow_name=\"onboard_sensors\")\n",
+    "            flow = flow_config.as_flow(\n",
+    "                timestamp=datetime.now(timezone.utc),\n",
+    "                values={\n",
+    "                    \"motor_temp\": 50.0 + random.random() * 5.0,\n",
+    "                    \"tank_pressure\": 2000.0 + random.random() * 100.0,\n",
+    "                },\n",
+    "            )\n",
+    "            # Ingest the flow with .send()\n",
+    "            await ingest_client.send(flow=flow)\n",
+    "\n",
+    "            await asyncio.sleep(1)\n",
+    "\n",
+    "\n",
+    "if __name__ == \"__main__\":\n",
+    "    asyncio.run(main())\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}