Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Onboard Austin Crime dataset #174

Merged
55 changes: 55 additions & 0 deletions datasets/austin_crime/_images/run_csv_transform_kub/Dockerfile
@@ -0,0 +1,55 @@
# 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:352.0.0-slim
# FROM python:3.8
FROM python:3.8

# Allow statements and log messages to appear in Cloud logs
ENV PYTHONUNBUFFERED True

RUN apt-get -y update && apt-get install -y apt-transport-https ca-certificates gnupg &&\
echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list &&\
# echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" > /etc/apt/sources.list.d/google-cloud-sdk.list && \
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - &&\
apt-get -y update && apt-get install -y google-cloud-sdk

# echo "deb https://packages.cloud.google.com/apt $CLOUD_SDK_REPO main" > /etc/apt/sources.list.d/google-cloud-sdk.list && \
# curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - && \
# apt-get update && apt-get install -y google-cloud-sdk=${CLOUD_SDK_VERSION}-0 $INSTALL_COMPONENTS && \



# echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && \
# apt-get update && apt-get install apt-transport-https ca-certificates gnupg && \
# curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key --keyring /usr/share/keyrings/cloud.google.gpg add - && \
# apt-get update && sudo apt-get install google-cloud-sdk
adlersantos marked this conversation as resolved.
Show resolved Hide resolved
# 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"]
252 changes: 252 additions & 0 deletions datasets/austin_crime/_images/run_csv_transform_kub/csv_transform.py
@@ -0,0 +1,252 @@
# 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 glob
import json
import logging
import math
import os
import pathlib
import re
import subprocess
import typing

import pandas as pd
from google.cloud import storage


def main(
source_url: typing.List[str],
source_file: typing.List[pathlib.Path],
source_files_path: str,
target_file: pathlib.Path,
target_gcs_bucket: str,
target_gcs_path: str,
headers: typing.List[str],
rename_mappings: dict,
) -> None:

logging.info(
"Austin crime process started at "
+ str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
)

logging.info("creating 'files' folder")
adlersantos marked this conversation as resolved.
Show resolved Hide resolved
pathlib.Path("./files").mkdir(parents=True, exist_ok=True)

logging.info("Downloading file ...")
download_file(source_url, source_file)

logging.info("Opening files...")
df = read_files(source_files_path)

logging.info("Transform: Rename columns...")
rename_headers(df, rename_mappings)

logging.info("Transform: Cleaning up column location_description...")
df["location_description"] = (
df["location_description"]
.astype("|S")
.str.decode("utf-8")
.apply(reg_exp_tranformation, args=(r"\s{2,}", ""))
)
adlersantos marked this conversation as resolved.
Show resolved Hide resolved

logging.info("Transform: Converting to integer string...")
df["zipcode"] = df["zipcode"].apply(convert_to_integer_string)
df["council_district_code"] = df["council_district_code"].apply(
convert_to_integer_string
)
df["x_coordinate"] = df["x_coordinate"].apply(convert_to_integer_string)
df["y_coordinate"] = df["y_coordinate"].apply(convert_to_integer_string)

logging.info("Transform: Creating a new column - address...")
df["address"] = df["address1"]
df["address"] = (
df["address"]
.fillna(
df["location_description"].replace("nan", "")
+ " Austin, TX "
+ df["zipcode"]
)
.str.strip()
)

logging.info("Transform: Converting date format...")
df["timestamp"] = df["timestamp"].apply(convert_dt_format)
df["clearance_date"] = df["clearance_date"].apply(convert_dt_format)

logging.info("Transform: Creating a new column - year...")
df["year"] = df["timestamp"].apply(extract_year)

logging.info("Transform: Replacing values...")
df["address"] = df["address"].apply(reg_exp_tranformation, args=(r"\n", " "))
df = df.replace(
to_replace={
"clearance_status": {
"C": "Cleared by Arrest",
"O": "Cleared by Exception",
"N": "Not cleared",
},
"address": {"sAustin": "Austin"},
}
)

logging.info("Transform: Converting exponential values to integer...")
df["unique_key"] = (
df["unique_key"]
.apply(convert_exp_to_float)
.astype(float)
.apply(convert_to_integer_string)
)

logging.info("Transform: Creating a new column - latitude...")
df["latitude"] = (
df["address"]
.apply(search_string)
.apply(extract_lat_long, args=[r".*\((\d+\.\d+),.*"])
)
adlersantos marked this conversation as resolved.
Show resolved Hide resolved

logging.info("Transform: Creating a new column - longitude...")
df["longitude"] = (
df["address"]
.apply(search_string)
.apply(extract_lat_long, args=[r".*(\-\d+\.\d+)\)"])
)

logging.info("Transform: Creating a new column - year...")
df["location"] = "(" + df["latitude"] + "," + df["longitude"] + ")"
adlersantos marked this conversation as resolved.
Show resolved Hide resolved

logging.info("Transform: Dropping column - address1...")
delete_column(df, "address1")
adlersantos marked this conversation as resolved.
Show resolved Hide resolved

logging.info("Transform: Reordering headers...")
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(
"Austin crime process completed at "
+ str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
)


def download_file(
source_url: typing.List[str], source_file: typing.List[pathlib.Path]
) -> None:
for url, file in zip(source_url, source_file):
logging.info(f"Downloading file from {url} ...")
subprocess.check_call(["gsutil", "cp", f"{url}", f"{file}"])


def read_files(path: pathlib.Path) -> pd.DataFrame:
all_files = glob.glob(path + "/*.csv")
li = []
adlersantos marked this conversation as resolved.
Show resolved Hide resolved
for filename in all_files:
frame = pd.read_csv(filename, index_col=None, header=0)
li.append(frame)
df = pd.concat(li, axis=0, ignore_index=True)
return df


def rename_headers(df: pd.DataFrame, rename_mappings: dict) -> None:
df.rename(columns=rename_mappings, inplace=True)


def reg_exp_tranformation(str_value: str, search_pattern: str, replace_val: str) -> str:
str_value = re.sub(search_pattern, replace_val, str_value)
return str_value


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


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":
adlersantos marked this conversation as resolved.
Show resolved Hide resolved
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 extract_year(string_val: str) -> str:
string_val = string_val[0:4]
return string_val


def convert_exp_to_float(exp_val: str) -> str:
float_val = "{:f}".format(float(exp_val))
return float_val


def search_string(str_value: str) -> str:
a = ""
if re.search(r".*\(.*\)", str_value):
return str(str_value)
else:
return str(a)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can skip defining a and simply return an empty string in the else clause

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's just me, but I'm not seeing any changes here. I could be seeing outdated stuff.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please check once again ? I can see updated code...



def extract_lat_long(str_val: str, patter: str) -> str:
m = re.match(patter, str_val)
if m:
return m.group(1)
adlersantos marked this conversation as resolved.
Show resolved Hide resolved


def delete_column(df: pd.DataFrame, column_name: str) -> None:
df = df.drop(column_name, axis=1, inplace=True)


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 save_to_new_file(df: pd.DataFrame, file_path: str) -> None:
df.to_csv(file_path, index=False)


if __name__ == "__main__":
logging.getLogger().setLevel(logging.INFO)

main(
source_url=json.loads(os.environ["SOURCE_URL"]),
source_file=json.loads(os.environ["SOURCE_FILE"]),
source_files_path=os.environ["FILE_PATH"],
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"]),
)
@@ -0,0 +1,3 @@
requests
pandas
google-cloud-storage
26 changes: 26 additions & 0 deletions datasets/austin_crime/_terraform/austin_crime_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" "austin_crime" {
dataset_id = "austin_crime"
project = var.project_id
description = "Austin Crime dataset"
}

output "bigquery_dataset-austin_crime-dataset_id" {
value = google_bigquery_dataset.austin_crime.dataset_id
}
39 changes: 39 additions & 0 deletions datasets/austin_crime/_terraform/crime_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" "crime" {
project = var.project_id
dataset_id = "austin_crime"
table_id = "crime"

description = "Austin Crime table"




depends_on = [
google_bigquery_dataset.austin_crime
]
}

output "bigquery_table-crime-table_id" {
value = google_bigquery_table.crime.table_id
}

output "bigquery_table-crime-id" {
value = google_bigquery_table.crime.id
}