From af6457eec01f978f2ee4a8acdb3b055db4cf82f4 Mon Sep 17 00:00:00 2001 From: Dipannita Banerjee Date: Mon, 13 Sep 2021 07:39:42 +0000 Subject: [PATCH 1/4] feat: Onboard San Farncisco Street Trees dataset --- .../_images/run_csv_transform_kub/Dockerfile | 38 ++++ .../run_csv_transform_kub/csv_transform.py | 149 ++++++++++++++ .../run_csv_transform_kub/requirements.txt | 3 + .../_terraform/provider.tf | 28 +++ .../_terraform/san_francisco_trees_dataset.tf | 26 +++ .../_terraform/street_trees_pipeline.tf | 39 ++++ .../_terraform/variables.tf | 23 +++ datasets/san_francisco_trees/dataset.yaml | 58 ++++++ .../street_trees/pipeline.yaml | 194 ++++++++++++++++++ .../street_trees/street_trees_dag.py | 194 ++++++++++++++++++ 10 files changed, 752 insertions(+) create mode 100644 datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile create mode 100644 datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py create mode 100644 datasets/san_francisco_trees/_images/run_csv_transform_kub/requirements.txt create mode 100644 datasets/san_francisco_trees/_terraform/provider.tf create mode 100644 datasets/san_francisco_trees/_terraform/san_francisco_trees_dataset.tf create mode 100644 datasets/san_francisco_trees/_terraform/street_trees_pipeline.tf create mode 100644 datasets/san_francisco_trees/_terraform/variables.tf create mode 100644 datasets/san_francisco_trees/dataset.yaml create mode 100644 datasets/san_francisco_trees/street_trees/pipeline.yaml create mode 100644 datasets/san_francisco_trees/street_trees/street_trees_dag.py diff --git a/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile b/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile new file mode 100644 index 000000000..85af90570 --- /dev/null +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile @@ -0,0 +1,38 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# The base image for this build +# FROM gcr.io/google.com/cloudsdktool/cloud-sdk:slim +FROM python:3.8 + +# Allow statements and log messages to appear in Cloud logs +ENV PYTHONUNBUFFERED True + +# Copy the requirements file into the image +COPY requirements.txt ./ + +# Install the packages specified in the requirements file +RUN python3 -m pip install --no-cache-dir -r requirements.txt + +# The WORKDIR instruction sets the working directory for any RUN, CMD, +# ENTRYPOINT, COPY and ADD instructions that follow it in the Dockerfile. +# If the WORKDIR doesn’t exist, it will be created even if it’s not used in +# any subsequent Dockerfile instruction +WORKDIR /custom + +# Copy the specific data processing script/s in the image under /custom/* +COPY ./csv_transform.py . + +# Command to run the data processing script when the container is run +CMD ["python3", "csv_transform.py"] diff --git a/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py b/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py new file mode 100644 index 000000000..d812f4ca0 --- /dev/null +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py @@ -0,0 +1,149 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import datetime +import json +import logging +import math +import os +import pathlib +import typing + +import pandas as pd +import requests +from google.cloud import storage + + +def main( + source_url: str, + source_file: pathlib.Path, + target_file: pathlib.Path, + target_gcs_bucket: str, + target_gcs_path: str, + headers: typing.List[str], + rename_mappings: dict, + pipeline_name: str, +) -> None: + + logging.info( + f"San Francisco Trees {pipeline_name} process started at " + + str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")) + ) + + logging.info("creating 'files' folder") + pathlib.Path("./files").mkdir(parents=True, exist_ok=True) + + logging.info(f"Downloading file {source_url}") + download_file(source_url, source_file) + + logging.info(f"Opening file {source_file}") + df = pd.read_csv(str(source_file)) + + logging.info(f"Transforming.. {source_file}") + + logging.info(f"Transform: Rename columns for {pipeline_name}..") + rename_headers(df, rename_mappings) + + logging.info(f"Transform: converting to integer for {pipeline_name}..") + df["site_order"] = df["site_order"].apply(convert_to_int) + + logging.info(f"Transform: converting date format for {pipeline_name}.. ") + df["plant_date"] = df["plant_date"].apply(convert_dt_format) + + logging.info(f"Transform: filtering Null values for {pipeline_name}.. ") + filter_null_rows(df) + + logging.info(f"Transform: Reordering headers for {pipeline_name}.. ") + df = df[headers] + + logging.info(f"Saving to output file.. {target_file}") + try: + save_to_new_file(df, file_path=str(target_file)) + except Exception as e: + logging.error(f"Error saving output file: {e}.") + + logging.info( + f"Uploading output file to.. gs://{target_gcs_bucket}/{target_gcs_path}" + ) + upload_file_to_gcs(target_file, target_gcs_bucket, target_gcs_path) + + logging.info( + f"San Francisco Trees {pipeline_name} process completed at " + + str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")) + ) + + +def convert_dt_format(dt_str: str) -> str: + a = "" + if dt_str is None or len(str(dt_str)) == 0 or str(dt_str) == "nan": + return str(a) + else: + return datetime.datetime.strptime(str(dt_str), "%m/%d/%Y %H:%M:%S %p").strftime( + "%Y-%m-%d %H:%M:%S" + ) + + +def save_to_new_file(df: pd.DataFrame, file_path: str) -> None: + df.to_csv(file_path, index=False) + + +def upload_file_to_gcs(file_path: pathlib.Path, gcs_bucket: str, gcs_path: str) -> None: + storage_client = storage.Client() + bucket = storage_client.bucket(gcs_bucket) + blob = bucket.blob(gcs_path) + blob.upload_from_filename(file_path) + + +def download_file(source_url: str, source_file: pathlib.Path) -> None: + logging.info(f"Downloading {source_url} into {source_file}") + r = requests.get(source_url, stream=True) + if r.status_code == 200: + with open(source_file, "wb") as f: + for chunk in r: + f.write(chunk) + else: + logging.error(f"Couldn't download {source_url}: {r.text}") + + +def filter_null_rows(df: pd.DataFrame) -> None: + df = df.query('tree_id != ""') + + +def rename_headers(df: pd.DataFrame, rename_mappings: dict) -> None: + df.rename(columns=rename_mappings, inplace=True) + + +def convert_to_int(input: str) -> str: + str_val = "" + if input == "" or (math.isnan(input)): + str_val = "" + else: + str_val = str(int(round(input, 0))) + return str_val + + +if __name__ == "__main__": + logging.getLogger().setLevel(logging.INFO) + + main( + source_url=os.environ["SOURCE_URL"], + source_file=pathlib.Path(os.environ["SOURCE_FILE"]).expanduser(), + target_file=pathlib.Path(os.environ["TARGET_FILE"]).expanduser(), + target_gcs_bucket=os.environ["TARGET_GCS_BUCKET"], + target_gcs_path=os.environ["TARGET_GCS_PATH"], + headers=json.loads(os.environ["CSV_HEADERS"]), + rename_mappings=json.loads(os.environ["RENAME_MAPPINGS"]), + pipeline_name=os.environ["PIPELINE_NAME"], + ) diff --git a/datasets/san_francisco_trees/_images/run_csv_transform_kub/requirements.txt b/datasets/san_francisco_trees/_images/run_csv_transform_kub/requirements.txt new file mode 100644 index 000000000..1c45cdfc3 --- /dev/null +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/requirements.txt @@ -0,0 +1,3 @@ +requests +google-cloud-storage +pandas diff --git a/datasets/san_francisco_trees/_terraform/provider.tf b/datasets/san_francisco_trees/_terraform/provider.tf new file mode 100644 index 000000000..23ab87dcd --- /dev/null +++ b/datasets/san_francisco_trees/_terraform/provider.tf @@ -0,0 +1,28 @@ +/** + * Copyright 2021 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +provider "google" { + project = var.project_id + impersonate_service_account = var.impersonating_acct + region = var.region +} + +data "google_client_openid_userinfo" "me" {} + +output "impersonating-account" { + value = data.google_client_openid_userinfo.me.email +} diff --git a/datasets/san_francisco_trees/_terraform/san_francisco_trees_dataset.tf b/datasets/san_francisco_trees/_terraform/san_francisco_trees_dataset.tf new file mode 100644 index 000000000..08e3d2b89 --- /dev/null +++ b/datasets/san_francisco_trees/_terraform/san_francisco_trees_dataset.tf @@ -0,0 +1,26 @@ +/** + * Copyright 2021 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +resource "google_bigquery_dataset" "san_francisco_trees" { + dataset_id = "san_francisco_trees" + project = var.project_id + description = "San Francisco Trees dataset" +} + +output "bigquery_dataset-san_francisco_trees-dataset_id" { + value = google_bigquery_dataset.san_francisco_trees.dataset_id +} diff --git a/datasets/san_francisco_trees/_terraform/street_trees_pipeline.tf b/datasets/san_francisco_trees/_terraform/street_trees_pipeline.tf new file mode 100644 index 000000000..56b16e64f --- /dev/null +++ b/datasets/san_francisco_trees/_terraform/street_trees_pipeline.tf @@ -0,0 +1,39 @@ +/** + * Copyright 2021 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +resource "google_bigquery_table" "street_trees" { + project = var.project_id + dataset_id = "san_francisco_trees" + table_id = "street_trees" + + description = "San Francisco street trees table" + + + + + depends_on = [ + google_bigquery_dataset.san_francisco_trees + ] +} + +output "bigquery_table-street_trees-table_id" { + value = google_bigquery_table.street_trees.table_id +} + +output "bigquery_table-street_trees-id" { + value = google_bigquery_table.street_trees.id +} diff --git a/datasets/san_francisco_trees/_terraform/variables.tf b/datasets/san_francisco_trees/_terraform/variables.tf new file mode 100644 index 000000000..c3ec7c506 --- /dev/null +++ b/datasets/san_francisco_trees/_terraform/variables.tf @@ -0,0 +1,23 @@ +/** + * Copyright 2021 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +variable "project_id" {} +variable "bucket_name_prefix" {} +variable "impersonating_acct" {} +variable "region" {} +variable "env" {} + diff --git a/datasets/san_francisco_trees/dataset.yaml b/datasets/san_francisco_trees/dataset.yaml new file mode 100644 index 000000000..576530702 --- /dev/null +++ b/datasets/san_francisco_trees/dataset.yaml @@ -0,0 +1,58 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +dataset: + # The `dataset` block includes properties for your dataset that will be shown + # to users of your data on the Google Cloud website. + + # Must be exactly the same name as the folder name your dataset.yaml is in. + name: san_francisco_trees + + # A friendly, human-readable name of the dataset + friendly_name: san_francisco_trees + + # A short, descriptive summary of the dataset. + description: "San Francisco Trees dataset" + + # A list of sources the dataset is derived from, using the YAML list syntax. + dataset_sources: ~ + + # A list of terms and conditions that users of the dataset should agree on, + # using the YAML list syntax. + terms_of_use: ~ + + +resources: + # A list of Google Cloud resources needed by your dataset. In principle, all + # pipelines under a dataset should be able to share these resources. + # + # The currently supported resources are shown below. Use only the resources + # you need, and delete the rest as needed by your pipeline. + # + # We will keep adding to the list below to support more Google Cloud resources + # over time. If a resource you need isn't supported, please file an issue on + # the repository. + + - type: bigquery_dataset + # Google BigQuery dataset to namespace all tables managed by this folder + # + # Required Properties: + # dataset_id + # + # Optional Properties: + # friendly_name (A user-friendly name of the dataset) + # description (A user-friendly description of the dataset) + # location (The geographic location where the dataset should reside) + dataset_id: san_francisco_trees + description: "San Francisco Trees dataset" diff --git a/datasets/san_francisco_trees/street_trees/pipeline.yaml b/datasets/san_francisco_trees/street_trees/pipeline.yaml new file mode 100644 index 000000000..5ffed7313 --- /dev/null +++ b/datasets/san_francisco_trees/street_trees/pipeline.yaml @@ -0,0 +1,194 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- +resources: + + - type: bigquery_table + # Required Properties: + table_id: street_trees + + # Description of the table + description: "San Francisco street trees table" + +dag: + airflow_version: 1 + initialize: + dag_id: street_trees + default_args: + owner: "Google" + + # When set to True, keeps a task from getting triggered if the previous schedule for the task hasn’t succeeded + depends_on_past: False + start_date: '2021-03-01' + max_active_runs: 1 + schedule_interval: "@daily" + catchup: False + default_view: graph + + tasks: + - operator: "KubernetesPodOperator" + + # Task description + description: "Run CSV transform within kubernetes pod" + + args: + + task_id: "street_trees_transform_csv" + + startup_timeout_seconds: 600 + + # The name of the pod in which the task will run. This will be used (plus a random suffix) to generate a pod id + name: "street_trees" + + # The namespace to run within Kubernetes. Always set its value to "default" because we follow the guideline that KubernetesPodOperator will only be used for very light workloads, i.e. use the Cloud Composer environment's resources without starving other pipelines. + namespace: "default" + + affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: cloud.google.com/gke-nodepool + operator: In + values: + - "pool-e2-standard-4" + + + image_pull_policy: "Always" + + # Docker images will be built and pushed to GCR by default whenever the `scripts/generate_dag.py` is run. To skip building and pushing images, use the optional `--skip-builds` flag. + image: "{{ var.json.san_francisco_trees.container_registry.run_csv_transform_kub }}" + + # Set the environment variables you need initialized in the container. Use these as input variables for the script your container is expected to perform. + env_vars: + SOURCE_URL: "https://data.sfgov.org/api/views/tkzw-k3nq/rows.csv" + SOURCE_FILE: "files/data.csv" + TARGET_FILE: "files/data_output.csv" + TARGET_GCS_BUCKET: "{{ var.json.shared.composer_bucket }}" + TARGET_GCS_PATH: "data/san_francisco_trees/street_trees/data_output.csv" + PIPELINE_NAME: "street_trees" + CSV_HEADERS: >- + ["tree_id","legal_status","species","address","site_order","site_info","plant_type","care_taker","care_assistant","plant_date","dbh","plot_size","permit_notes","x_coordinate","y_coordinate","latitude","longitude","location"] + RENAME_MAPPINGS: >- + {"TreeID" : "tree_id" ,"qLegalStatus" : "legal_status" ,"qSpecies" : "species" ,"qAddress" : "address" ,"SiteOrder" : "site_order" ,"qSiteInfo" : "site_info" ,"PlantType" : "plant_type" ,"qCaretaker" : "care_taker" ,"qCareAssistant" : "care_assistant" ,"PlantDate" : "plant_date" ,"DBH" : "dbh" ,"PlotSize" : "plot_size" ,"PermitNotes" : "permit_notes" ,"XCoord" : "x_coordinate" ,"YCoord" : "y_coordinate" ,"Latitude" : "latitude" ,"Longitude" : "longitude" ,"Location" : "location"} + + # Set resource limits for the pod here. For resource units in Kubernetes, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes + resources: + request_memory: "2G" + request_cpu: "1" + + - operator: "GoogleCloudStorageToBigQueryOperator" + description: "Task to load CSV data to a BigQuery table" + + args: + task_id: "load_street_trees_to_bq" + + # The GCS bucket where the CSV file is located in. + bucket: "{{ var.json.shared.composer_bucket }}" + + # The GCS object path for the CSV file + source_objects: ["data/san_francisco_trees/street_trees/data_output.csv"] + source_format: "CSV" + destination_project_dataset_table: "san_francisco_trees.street_trees" + + # Use this if your CSV file contains a header row + skip_leading_rows: 1 + + # How to write data to the table: overwrite, append, or write if empty + # See https://cloud.google.com/bigquery/docs/reference/auditlogs/rest/Shared.Types/WriteDisposition + write_disposition: "WRITE_TRUNCATE" + + # The BigQuery table schema based on the CSV file. For more info, see + # https://cloud.google.com/bigquery/docs/schemas. + # Always use snake_case and lowercase for column names, and be explicit, + # i.e. specify modes for all columns. + + schema_fields: + - name: "tree_id" + type: "integer" + description: "Unique ID for Tree" + mode: "required" + - name: "legal_status" + type: "string" + description: "Legal staus: Permitted or DPW maintained" + mode: "nullable" + - name: "species" + type: "string" + description: "Species of tree" + mode: "nullable" + - name: "address" + type: "string" + description: "Address of Tree" + mode: "nullable" + - name: "site_order" + type: "integer" + description: "Order of tree at address where multiple trees are at same address. Trees are ordered in ascending address order" + mode: "nullable" + - name: "site_info" + type: "string" + description: "Description of location of tree" + mode: "nullable" + - name: "plant_type" + type: "string" + description: "Landscaping or Tree" + mode: "nullable" + - name: "care_taker" + type: "string" + description: "Agency or person that is primary caregiver to tree. Owner of Tree" + mode: "nullable" + - name: "care_assistant" + type: "string" + description: "Agency or person that is secondary caregiver to tree" + mode: "nullable" + - name: "plant_date" + type: "timestamp" + description: "Date tree was planted" + mode: "nullable" + - name: "dbh" + type: "string" + description: "depth height" + mode: "nullable" + - name: "plot_size" + type: "string" + description: "dimension of tree plot" + mode: "nullable" + - name: "permit_notes" + type: "string" + description: "Tree permit number reference" + mode: "nullable" + - name: "x_coordinate" + type: "float" + description: "CA State Plane III" + mode: "nullable" + - name: "y_coordinate" + type: "float" + description: "CA State Plane III" + mode: "nullable" + - name: "latitude" + type: "float" + description: "WGS84" + mode: "nullable" + - name: "longitude" + type: "float" + description: "WGS84" + mode: "nullable" + - name: "location" + type: "string" + description: "Location formatted for mapping" + mode: "nullable" + + + graph_paths: + - "street_trees_transform_csv >> load_street_trees_to_bq" diff --git a/datasets/san_francisco_trees/street_trees/street_trees_dag.py b/datasets/san_francisco_trees/street_trees/street_trees_dag.py new file mode 100644 index 000000000..54d0c546d --- /dev/null +++ b/datasets/san_francisco_trees/street_trees/street_trees_dag.py @@ -0,0 +1,194 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from airflow import DAG +from airflow.contrib.operators import gcs_to_bq, kubernetes_pod_operator + +default_args = { + "owner": "Google", + "depends_on_past": False, + "start_date": "2021-03-01", +} + + +with DAG( + dag_id="san_francisco_trees.street_trees", + default_args=default_args, + max_active_runs=1, + schedule_interval="@daily", + catchup=False, + default_view="graph", +) as dag: + + # Run CSV transform within kubernetes pod + street_trees_transform_csv = kubernetes_pod_operator.KubernetesPodOperator( + task_id="street_trees_transform_csv", + startup_timeout_seconds=600, + name="street_trees", + namespace="default", + affinity={ + "nodeAffinity": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "nodeSelectorTerms": [ + { + "matchExpressions": [ + { + "key": "cloud.google.com/gke-nodepool", + "operator": "In", + "values": ["pool-e2-standard-4"], + } + ] + } + ] + } + } + }, + image_pull_policy="Always", + image="{{ var.json.san_francisco_trees.container_registry.run_csv_transform_kub }}", + env_vars={ + "SOURCE_URL": "https://data.sfgov.org/api/views/tkzw-k3nq/rows.csv", + "SOURCE_FILE": "files/data.csv", + "TARGET_FILE": "files/data_output.csv", + "TARGET_GCS_BUCKET": "{{ var.json.shared.composer_bucket }}", + "TARGET_GCS_PATH": "data/san_francisco_trees/street_trees/data_output.csv", + "PIPELINE_NAME": "street_trees", + "CSV_HEADERS": '["tree_id","legal_status","species","address","site_order","site_info","plant_type","care_taker","care_assistant","plant_date","dbh","plot_size","permit_notes","x_coordinate","y_coordinate","latitude","longitude","location"]', + "RENAME_MAPPINGS": '{"TreeID" : "tree_id" ,"qLegalStatus" : "legal_status" ,"qSpecies" : "species" ,"qAddress" : "address" ,"SiteOrder" : "site_order" ,"qSiteInfo" : "site_info" ,"PlantType" : "plant_type" ,"qCaretaker" : "care_taker" ,"qCareAssistant" : "care_assistant" ,"PlantDate" : "plant_date" ,"DBH" : "dbh" ,"PlotSize" : "plot_size" ,"PermitNotes" : "permit_notes" ,"XCoord" : "x_coordinate" ,"YCoord" : "y_coordinate" ,"Latitude" : "latitude" ,"Longitude" : "longitude" ,"Location" : "location"}', + }, + resources={"request_memory": "2G", "request_cpu": "1"}, + ) + + # Task to load CSV data to a BigQuery table + load_street_trees_to_bq = gcs_to_bq.GoogleCloudStorageToBigQueryOperator( + task_id="load_street_trees_to_bq", + bucket="{{ var.json.shared.composer_bucket }}", + source_objects=["data/san_francisco_trees/street_trees/data_output.csv"], + source_format="CSV", + destination_project_dataset_table="san_francisco_trees.street_trees", + skip_leading_rows=1, + write_disposition="WRITE_TRUNCATE", + schema_fields=[ + { + "name": "tree_id", + "type": "integer", + "description": "Unique ID for Tree", + "mode": "required", + }, + { + "name": "legal_status", + "type": "string", + "description": "Legal staus: Permitted or DPW maintained", + "mode": "nullable", + }, + { + "name": "species", + "type": "string", + "description": "Species of tree", + "mode": "nullable", + }, + { + "name": "address", + "type": "string", + "description": "Address of Tree", + "mode": "nullable", + }, + { + "name": "site_order", + "type": "integer", + "description": "Order of tree at address where multiple trees are at same address. Trees are ordered in ascending address order", + "mode": "nullable", + }, + { + "name": "site_info", + "type": "string", + "description": "Description of location of tree", + "mode": "nullable", + }, + { + "name": "plant_type", + "type": "string", + "description": "Landscaping or Tree", + "mode": "nullable", + }, + { + "name": "care_taker", + "type": "string", + "description": "Agency or person that is primary caregiver to tree. Owner of Tree", + "mode": "nullable", + }, + { + "name": "care_assistant", + "type": "string", + "description": "Agency or person that is secondary caregiver to tree", + "mode": "nullable", + }, + { + "name": "plant_date", + "type": "timestamp", + "description": "Date tree was planted", + "mode": "nullable", + }, + { + "name": "dbh", + "type": "string", + "description": "depth height", + "mode": "nullable", + }, + { + "name": "plot_size", + "type": "string", + "description": "dimension of tree plot", + "mode": "nullable", + }, + { + "name": "permit_notes", + "type": "string", + "description": "Tree permit number reference", + "mode": "nullable", + }, + { + "name": "x_coordinate", + "type": "float", + "description": "CA State Plane III", + "mode": "nullable", + }, + { + "name": "y_coordinate", + "type": "float", + "description": "CA State Plane III", + "mode": "nullable", + }, + { + "name": "latitude", + "type": "float", + "description": "WGS84", + "mode": "nullable", + }, + { + "name": "longitude", + "type": "float", + "description": "WGS84", + "mode": "nullable", + }, + { + "name": "location", + "type": "string", + "description": "Location formatted for mapping", + "mode": "nullable", + }, + ], + ) + + street_trees_transform_csv >> load_street_trees_to_bq From 02f4917a0d626dc742a846325513a5f14da9e9ad Mon Sep 17 00:00:00 2001 From: Dipannita Banerjee Date: Mon, 20 Sep 2021 07:28:55 +0000 Subject: [PATCH 2/4] style : removing commented lines --- .../run_csv_transform_kub/csv_transform.py | 16 +++++++-------- .../street_trees/pipeline.yaml | 20 +------------------ 2 files changed, 9 insertions(+), 27 deletions(-) diff --git a/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py b/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py index d812f4ca0..f87c01ad3 100644 --- a/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/csv_transform.py @@ -42,7 +42,7 @@ def main( + str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")) ) - logging.info("creating 'files' folder") + logging.info("Creating 'files' folder") pathlib.Path("./files").mkdir(parents=True, exist_ok=True) logging.info(f"Downloading file {source_url}") @@ -56,13 +56,13 @@ def main( logging.info(f"Transform: Rename columns for {pipeline_name}..") rename_headers(df, rename_mappings) - logging.info(f"Transform: converting to integer for {pipeline_name}..") - df["site_order"] = df["site_order"].apply(convert_to_int) + logging.info(f"Transform: Converting to integer for {pipeline_name}..") + df["site_order"] = df["site_order"].apply(convert_to_integer_string) - logging.info(f"Transform: converting date format for {pipeline_name}.. ") + logging.info(f"Transform: Converting date format for {pipeline_name}.. ") df["plant_date"] = df["plant_date"].apply(convert_dt_format) - logging.info(f"Transform: filtering Null values for {pipeline_name}.. ") + logging.info(f"Transform: Filtering Null values for {pipeline_name}.. ") filter_null_rows(df) logging.info(f"Transform: Reordering headers for {pipeline_name}.. ") @@ -87,7 +87,7 @@ def main( def convert_dt_format(dt_str: str) -> str: a = "" - if dt_str is None or len(str(dt_str)) == 0 or str(dt_str) == "nan": + if not dt_str or str(dt_str) == "nan": return str(a) else: return datetime.datetime.strptime(str(dt_str), "%m/%d/%Y %H:%M:%S %p").strftime( @@ -125,9 +125,9 @@ def rename_headers(df: pd.DataFrame, rename_mappings: dict) -> None: df.rename(columns=rename_mappings, inplace=True) -def convert_to_int(input: str) -> str: +def convert_to_integer_string(input: typing.Union[str, float]) -> str: str_val = "" - if input == "" or (math.isnan(input)): + if not input or (math.isnan(input)): str_val = "" else: str_val = str(int(round(input, 0))) diff --git a/datasets/san_francisco_trees/street_trees/pipeline.yaml b/datasets/san_francisco_trees/street_trees/pipeline.yaml index 5ffed7313..39fda1dca 100644 --- a/datasets/san_francisco_trees/street_trees/pipeline.yaml +++ b/datasets/san_francisco_trees/street_trees/pipeline.yaml @@ -16,10 +16,8 @@ resources: - type: bigquery_table - # Required Properties: table_id: street_trees - # Description of the table description: "San Francisco street trees table" dag: @@ -29,7 +27,6 @@ dag: default_args: owner: "Google" - # When set to True, keeps a task from getting triggered if the previous schedule for the task hasn’t succeeded depends_on_past: False start_date: '2021-03-01' max_active_runs: 1 @@ -40,7 +37,6 @@ dag: tasks: - operator: "KubernetesPodOperator" - # Task description description: "Run CSV transform within kubernetes pod" args: @@ -49,10 +45,8 @@ dag: startup_timeout_seconds: 600 - # The name of the pod in which the task will run. This will be used (plus a random suffix) to generate a pod id name: "street_trees" - # The namespace to run within Kubernetes. Always set its value to "default" because we follow the guideline that KubernetesPodOperator will only be used for very light workloads, i.e. use the Cloud Composer environment's resources without starving other pipelines. namespace: "default" affinity: @@ -68,10 +62,8 @@ dag: image_pull_policy: "Always" - # Docker images will be built and pushed to GCR by default whenever the `scripts/generate_dag.py` is run. To skip building and pushing images, use the optional `--skip-builds` flag. image: "{{ var.json.san_francisco_trees.container_registry.run_csv_transform_kub }}" - # Set the environment variables you need initialized in the container. Use these as input variables for the script your container is expected to perform. env_vars: SOURCE_URL: "https://data.sfgov.org/api/views/tkzw-k3nq/rows.csv" SOURCE_FILE: "files/data.csv" @@ -84,7 +76,6 @@ dag: RENAME_MAPPINGS: >- {"TreeID" : "tree_id" ,"qLegalStatus" : "legal_status" ,"qSpecies" : "species" ,"qAddress" : "address" ,"SiteOrder" : "site_order" ,"qSiteInfo" : "site_info" ,"PlantType" : "plant_type" ,"qCaretaker" : "care_taker" ,"qCareAssistant" : "care_assistant" ,"PlantDate" : "plant_date" ,"DBH" : "dbh" ,"PlotSize" : "plot_size" ,"PermitNotes" : "permit_notes" ,"XCoord" : "x_coordinate" ,"YCoord" : "y_coordinate" ,"Latitude" : "latitude" ,"Longitude" : "longitude" ,"Location" : "location"} - # Set resource limits for the pod here. For resource units in Kubernetes, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes resources: request_memory: "2G" request_cpu: "1" @@ -95,26 +86,17 @@ dag: args: task_id: "load_street_trees_to_bq" - # The GCS bucket where the CSV file is located in. + bucket: "{{ var.json.shared.composer_bucket }}" - # The GCS object path for the CSV file source_objects: ["data/san_francisco_trees/street_trees/data_output.csv"] source_format: "CSV" destination_project_dataset_table: "san_francisco_trees.street_trees" - # Use this if your CSV file contains a header row skip_leading_rows: 1 - # How to write data to the table: overwrite, append, or write if empty - # See https://cloud.google.com/bigquery/docs/reference/auditlogs/rest/Shared.Types/WriteDisposition write_disposition: "WRITE_TRUNCATE" - # The BigQuery table schema based on the CSV file. For more info, see - # https://cloud.google.com/bigquery/docs/schemas. - # Always use snake_case and lowercase for column names, and be explicit, - # i.e. specify modes for all columns. - schema_fields: - name: "tree_id" type: "integer" From 5a639aefecde7a721aa22013d3c864daebccda07 Mon Sep 17 00:00:00 2001 From: Dipannita Banerjee Date: Wed, 22 Sep 2021 08:07:01 +0000 Subject: [PATCH 3/4] style: removed commented lines --- datasets/san_francisco_trees/dataset.yaml | 30 +------------------ .../street_trees/pipeline.yaml | 4 +-- .../street_trees/street_trees_dag.py | 4 +-- 3 files changed, 5 insertions(+), 33 deletions(-) diff --git a/datasets/san_francisco_trees/dataset.yaml b/datasets/san_francisco_trees/dataset.yaml index 576530702..0cdc00545 100644 --- a/datasets/san_francisco_trees/dataset.yaml +++ b/datasets/san_francisco_trees/dataset.yaml @@ -13,46 +13,18 @@ # limitations under the License. dataset: - # The `dataset` block includes properties for your dataset that will be shown - # to users of your data on the Google Cloud website. - - # Must be exactly the same name as the folder name your dataset.yaml is in. name: san_francisco_trees - # A friendly, human-readable name of the dataset friendly_name: san_francisco_trees - # A short, descriptive summary of the dataset. description: "San Francisco Trees dataset" - # A list of sources the dataset is derived from, using the YAML list syntax. dataset_sources: ~ - - # A list of terms and conditions that users of the dataset should agree on, - # using the YAML list syntax. terms_of_use: ~ resources: - # A list of Google Cloud resources needed by your dataset. In principle, all - # pipelines under a dataset should be able to share these resources. - # - # The currently supported resources are shown below. Use only the resources - # you need, and delete the rest as needed by your pipeline. - # - # We will keep adding to the list below to support more Google Cloud resources - # over time. If a resource you need isn't supported, please file an issue on - # the repository. - - type: bigquery_dataset - # Google BigQuery dataset to namespace all tables managed by this folder - # - # Required Properties: - # dataset_id - # - # Optional Properties: - # friendly_name (A user-friendly name of the dataset) - # description (A user-friendly description of the dataset) - # location (The geographic location where the dataset should reside) + dataset_id: san_francisco_trees description: "San Francisco Trees dataset" diff --git a/datasets/san_francisco_trees/street_trees/pipeline.yaml b/datasets/san_francisco_trees/street_trees/pipeline.yaml index 39fda1dca..ad766e7ef 100644 --- a/datasets/san_francisco_trees/street_trees/pipeline.yaml +++ b/datasets/san_francisco_trees/street_trees/pipeline.yaml @@ -68,7 +68,7 @@ dag: SOURCE_URL: "https://data.sfgov.org/api/views/tkzw-k3nq/rows.csv" SOURCE_FILE: "files/data.csv" TARGET_FILE: "files/data_output.csv" - TARGET_GCS_BUCKET: "{{ var.json.shared.composer_bucket }}" + TARGET_GCS_BUCKET: "{{ var.value.composer_bucket }}" TARGET_GCS_PATH: "data/san_francisco_trees/street_trees/data_output.csv" PIPELINE_NAME: "street_trees" CSV_HEADERS: >- @@ -87,7 +87,7 @@ dag: task_id: "load_street_trees_to_bq" - bucket: "{{ var.json.shared.composer_bucket }}" + bucket: "{{ var.value.composer_bucket }}" source_objects: ["data/san_francisco_trees/street_trees/data_output.csv"] source_format: "CSV" diff --git a/datasets/san_francisco_trees/street_trees/street_trees_dag.py b/datasets/san_francisco_trees/street_trees/street_trees_dag.py index 54d0c546d..cdf70df4c 100644 --- a/datasets/san_francisco_trees/street_trees/street_trees_dag.py +++ b/datasets/san_francisco_trees/street_trees/street_trees_dag.py @@ -61,7 +61,7 @@ "SOURCE_URL": "https://data.sfgov.org/api/views/tkzw-k3nq/rows.csv", "SOURCE_FILE": "files/data.csv", "TARGET_FILE": "files/data_output.csv", - "TARGET_GCS_BUCKET": "{{ var.json.shared.composer_bucket }}", + "TARGET_GCS_BUCKET": "{{ var.value.composer_bucket }}", "TARGET_GCS_PATH": "data/san_francisco_trees/street_trees/data_output.csv", "PIPELINE_NAME": "street_trees", "CSV_HEADERS": '["tree_id","legal_status","species","address","site_order","site_info","plant_type","care_taker","care_assistant","plant_date","dbh","plot_size","permit_notes","x_coordinate","y_coordinate","latitude","longitude","location"]', @@ -73,7 +73,7 @@ # Task to load CSV data to a BigQuery table load_street_trees_to_bq = gcs_to_bq.GoogleCloudStorageToBigQueryOperator( task_id="load_street_trees_to_bq", - bucket="{{ var.json.shared.composer_bucket }}", + bucket="{{ var.value.composer_bucket }}", source_objects=["data/san_francisco_trees/street_trees/data_output.csv"], source_format="CSV", destination_project_dataset_table="san_francisco_trees.street_trees", From 1b0ca1be3950a3c12dd0407c6ef7e7f88190553e Mon Sep 17 00:00:00 2001 From: Dipannita Banerjee Date: Tue, 5 Oct 2021 16:03:24 +0000 Subject: [PATCH 4/4] feat: removed white spaces from yaml files --- .../_images/run_csv_transform_kub/Dockerfile | 1 - datasets/san_francisco_trees/dataset.yaml | 4 ---- .../street_trees/pipeline.yaml | 19 ------------------- 3 files changed, 24 deletions(-) diff --git a/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile b/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile index 85af90570..7265a1b71 100644 --- a/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile @@ -13,7 +13,6 @@ # limitations under the License. # The base image for this build -# FROM gcr.io/google.com/cloudsdktool/cloud-sdk:slim FROM python:3.8 # Allow statements and log messages to appear in Cloud logs diff --git a/datasets/san_francisco_trees/dataset.yaml b/datasets/san_francisco_trees/dataset.yaml index 0cdc00545..3ec6211f6 100644 --- a/datasets/san_francisco_trees/dataset.yaml +++ b/datasets/san_francisco_trees/dataset.yaml @@ -14,17 +14,13 @@ dataset: name: san_francisco_trees - friendly_name: san_francisco_trees - description: "San Francisco Trees dataset" - dataset_sources: ~ terms_of_use: ~ resources: - type: bigquery_dataset - dataset_id: san_francisco_trees description: "San Francisco Trees dataset" diff --git a/datasets/san_francisco_trees/street_trees/pipeline.yaml b/datasets/san_francisco_trees/street_trees/pipeline.yaml index ad766e7ef..847773cf5 100644 --- a/datasets/san_francisco_trees/street_trees/pipeline.yaml +++ b/datasets/san_francisco_trees/street_trees/pipeline.yaml @@ -17,7 +17,6 @@ resources: - type: bigquery_table table_id: street_trees - description: "San Francisco street trees table" dag: @@ -26,7 +25,6 @@ dag: dag_id: street_trees default_args: owner: "Google" - depends_on_past: False start_date: '2021-03-01' max_active_runs: 1 @@ -36,19 +34,12 @@ dag: tasks: - operator: "KubernetesPodOperator" - description: "Run CSV transform within kubernetes pod" - args: - task_id: "street_trees_transform_csv" - startup_timeout_seconds: 600 - name: "street_trees" - namespace: "default" - affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: @@ -58,10 +49,7 @@ dag: operator: In values: - "pool-e2-standard-4" - - image_pull_policy: "Always" - image: "{{ var.json.san_francisco_trees.container_registry.run_csv_transform_kub }}" env_vars: @@ -75,26 +63,19 @@ dag: ["tree_id","legal_status","species","address","site_order","site_info","plant_type","care_taker","care_assistant","plant_date","dbh","plot_size","permit_notes","x_coordinate","y_coordinate","latitude","longitude","location"] RENAME_MAPPINGS: >- {"TreeID" : "tree_id" ,"qLegalStatus" : "legal_status" ,"qSpecies" : "species" ,"qAddress" : "address" ,"SiteOrder" : "site_order" ,"qSiteInfo" : "site_info" ,"PlantType" : "plant_type" ,"qCaretaker" : "care_taker" ,"qCareAssistant" : "care_assistant" ,"PlantDate" : "plant_date" ,"DBH" : "dbh" ,"PlotSize" : "plot_size" ,"PermitNotes" : "permit_notes" ,"XCoord" : "x_coordinate" ,"YCoord" : "y_coordinate" ,"Latitude" : "latitude" ,"Longitude" : "longitude" ,"Location" : "location"} - resources: request_memory: "2G" request_cpu: "1" - operator: "GoogleCloudStorageToBigQueryOperator" description: "Task to load CSV data to a BigQuery table" - args: task_id: "load_street_trees_to_bq" - - bucket: "{{ var.value.composer_bucket }}" - source_objects: ["data/san_francisco_trees/street_trees/data_output.csv"] source_format: "CSV" destination_project_dataset_table: "san_francisco_trees.street_trees" - skip_leading_rows: 1 - write_disposition: "WRITE_TRUNCATE" schema_fields: