feat: Onboard IRS 990 dataset (#150)

datasets/irs_990/_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"]

datasets/irs_990/_images/run_csv_transform_kub/Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+requests = "*"
+vaex = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"

datasets/irs_990/_images/run_csv_transform_kub/csv_transform.py

@@ -0,0 +1,156 @@
+# 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 re
+import typing
+from urllib.parse import urlparse
+
+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"irs 990 {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 from {source_url}... ")
+    download_file(source_url, source_file)
+
+    logging.info(f"Opening file {source_file} ... ")
+    str_value = os.path.basename(urlparse(source_url).path)
+
+    if re.search("zip", str_value):
+        df = pd.read_csv(
+            str(source_file), compression="zip", encoding="utf-8", sep=r"\s+"
+        )
+    else:
+        df = pd.read_csv(str(source_file), encoding="utf-8", sep=r"\s+")
+
+    logging.info(f"Transforming {source_file} ...")
+
+    logging.info(f"Transform: Rename columns {source_file} ...")
+    rename_headers(df, rename_mappings)
+
+    logging.info(f"Transform: filtering null values {source_file} ...")
+    filter_null_rows(df)
+
+    logging.info(f"Transform: converting to integer {source_file} ...")
+
+    if re.search("pf", pipeline_name):
+        df.invstexcisetx = df.invstexcisetx.replace("N", 0)
+        df.crelamt = df.crelamt.replace("N", 0)
+        df.dvdndsinte = df.dvdndsinte.replace("N", 0)
+        df.intrstrvnue = df.intrstrvnue.replace("N", 0)
+    else:
+        df["totsupp509"] = df["totsupp509"].apply(convert_to_int)
+
+    logging.info(
+        f"Transform: Reordering headers for {os.path.basename(urlparse(source_url).path)} ..."
+    )
+
+    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"irs 990 {pipeline_name} process completed at "
+        + str(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
+    )
+
+
+def rename_headers(df: pd.DataFrame, rename_mappings: dict) -> None:
+    df = df.rename(columns=rename_mappings, inplace=True)
+
+
+def filter_null_rows(df: pd.DataFrame) -> None:
+    df = df[df.ein != ""]
+
+
+def save_to_new_file(df: pd.DataFrame, file_path: pathlib.Path) -> None:
+    # df.export_csv(file_path)
+    df.to_csv(file_path, index=False)
+
+
+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 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
+
+
+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)
+
+
+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"],
+    )

datasets/irs_990/_images/run_csv_transform_kub/requirements.txt

@@ -0,0 +1,3 @@
+requests
+google-cloud-storage
+pandas

datasets/irs_990/_terraform/irs_990_2014_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" "irs_990_2014" {
+  project    = var.project_id
+  dataset_id = "irs_990"
+  table_id   = "irs_990_2014"
+
+  description = "IRS 990 2014 dataset"
+
+
+
+
+  depends_on = [
+    google_bigquery_dataset.irs_990
+  ]
+}
+
+output "bigquery_table-irs_990_2014-table_id" {
+  value = google_bigquery_table.irs_990_2014.table_id
+}
+
+output "bigquery_table-irs_990_2014-id" {
+  value = google_bigquery_table.irs_990_2014.id
+}

datasets/irs_990/_terraform/irs_990_2015_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" "irs_990_2015" {
+  project    = var.project_id
+  dataset_id = "irs_990"
+  table_id   = "irs_990_2015"
+
+  description = "IRS 990 2015 dataset"
+
+
+
+
+  depends_on = [
+    google_bigquery_dataset.irs_990
+  ]
+}
+
+output "bigquery_table-irs_990_2015-table_id" {
+  value = google_bigquery_table.irs_990_2015.table_id
+}
+
+output "bigquery_table-irs_990_2015-id" {
+  value = google_bigquery_table.irs_990_2015.id
+}

datasets/irs_990/_terraform/irs_990_2016_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" "irs_990_2016" {
+  project    = var.project_id
+  dataset_id = "irs_990"
+  table_id   = "irs_990_2016"
+
+  description = "IRS 990 2016 dataset"
+
+
+
+
+  depends_on = [
+    google_bigquery_dataset.irs_990
+  ]
+}
+
+output "bigquery_table-irs_990_2016-table_id" {
+  value = google_bigquery_table.irs_990_2016.table_id
+}
+
+output "bigquery_table-irs_990_2016-id" {
+  value = google_bigquery_table.irs_990_2016.id
+}

datasets/irs_990/_terraform/irs_990_2017_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" "irs_990_2017" {
+  project    = var.project_id
+  dataset_id = "irs_990"
+  table_id   = "irs_990_2017"
+
+  description = "IRS 990 2017 dataset"
+
+
+
+
+  depends_on = [
+    google_bigquery_dataset.irs_990
+  ]
+}
+
+output "bigquery_table-irs_990_2017-table_id" {
+  value = google_bigquery_table.irs_990_2017.table_id
+}
+
+output "bigquery_table-irs_990_2017-id" {
+  value = google_bigquery_table.irs_990_2017.id
+}