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..7265a1b71 --- /dev/null +++ b/datasets/san_francisco_trees/_images/run_csv_transform_kub/Dockerfile @@ -0,0 +1,37 @@ +# 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 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..f87c01ad3 --- /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_integer_string) + + 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 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( + "%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_integer_string(input: typing.Union[str, float]) -> str: + str_val = "" + if not 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..3ec6211f6 --- /dev/null +++ b/datasets/san_francisco_trees/dataset.yaml @@ -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. + +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 new file mode 100644 index 000000000..847773cf5 --- /dev/null +++ b/datasets/san_francisco_trees/street_trees/pipeline.yaml @@ -0,0 +1,157 @@ +# 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 + table_id: street_trees + description: "San Francisco street trees table" + +dag: + airflow_version: 1 + initialize: + dag_id: street_trees + default_args: + owner: "Google" + depends_on_past: False + start_date: '2021-03-01' + max_active_runs: 1 + schedule_interval: "@daily" + catchup: False + default_view: graph + + 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: + 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.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"] + 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: + - 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..cdf70df4c --- /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.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"]', + "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.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=[ + { + "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