Feature/pdct 1368 add the ability to read in all relevant data files

Makefile

@@ -1,23 +1,30 @@
-install_trunk:
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help: ## Display this help message
+	@echo "Available commands:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+install_trunk: ## Install trunk
 	$(eval trunk_installed=$(shell trunk --version > /dev/null 2>&1 ; echo $$? ))
 ifneq (${trunk_installed},0)
 	$(eval OS_NAME=$(shell uname -s | tr A-Z a-z))
 	curl https://get.trunk.io -fsSL | bash
 endif
 
-uninstall_trunk:
+uninstall_trunk: ## Uninstall trunk
 	sudo rm -if `which trunk`
 	rm -ifr ${HOME}/.cache/trunk
 
 share_trunk:
 	trunk init
 
-move_workflows:
+move_workflows: ## Move workflows to .github/workflows
 	mv workflows .github/workflows
 
 init: share_trunk move_workflows
 
-setup_with_pyenv:
+setup_with_pyenv: ## Setup the project with pyenv
 	pyenv install 3.10
 	pyenv virtualenv 3.10 gcf-dm
 	pyenv activate gcf-dm
@@ -26,12 +33,12 @@ setup_with_pyenv:
 install_git_hooks: install_trunk
 	trunk init
 
-check:
+check: ## Format and check the project with trunk
 	trunk fmt
 	trunk check
 
-build:
+build: ## Build the project
 	poetry build
 
-test:
+test: ## Run tests using pytest
 	poetry run pytest

gcf_data_mapper/read.py

@@ -0,0 +1,36 @@
+import csv
+import json
+from typing import Any, Optional
+
+import click
+
+
+def read_csv(file_path: str) -> list[str]:
+    """Reads a csv file and returns a list of values"""
+    with open(file_path, "r") as file:
+        csv_reader = csv.DictReader(file)
+        data = []
+        for line in csv_reader:
+            data.append(line["country"])
+        return data
+
+
+def read_json(file_path: str) -> dict:
+    """Reads a json file, we will just read the file for now and echo a value"""
+    with open(file_path, "r") as file:
+        data = file.read()
+        return json.loads(data)
+
+
+def read_data_file(file_path: str) -> Optional[dict[str, Any] | list[str]]:
+    """Simple program that reads a data file, calls a function to read a csv or json file respectively"""
+    file_extension = file_path.lower().split(".")[-1]
+    if file_extension not in ["json", "csv"]:
+        raise ValueError("Error reading file: File must be a valid json or csv file")
+    try:
+        if file_extension == "csv":
+            return read_csv(file_path)
+        elif file_extension == "json":
+            return read_json(file_path)
+    except Exception as e:
+        click.echo(f"Error reading file: {e}")

tests/unit_tests/test_fixtures/test.csv

@@ -0,0 +1,4 @@
+country,capital,avg_temp_celsius,annual_rainfall_mm,climate_zone
+Brazil,Brasilia,21.5,1500,Tropical
+Canada,Ottawa,6.3,940,Continental
+Egypt,Cairo,22.1,25,Desert

tests/unit_tests/test_fixtures/test.json

@@ -0,0 +1,24 @@
+{
+  "climate_data": [
+    {
+      "country": "Brazil",
+      "capital": "Brasilia",
+      "climate_info": {
+        "avg_temp_celsius": 21.5,
+        "annual_rainfall_mm": 1500,
+        "climate_zone": "Tropical"
+      },
+      "natural_disasters": ["Floods", "Landslides"]
+    },
+    {
+      "country": "Canada",
+      "capital": "Ottawa",
+      "climate_info": {
+        "avg_temp_celsius": 6.3,
+        "annual_rainfall_mm": 940,
+        "climate_zone": "Continental"
+      },
+      "natural_disasters": ["Blizzards", "Wildfires"]
+    }
+  ]
+}

tests/unit_tests/test_fixtures/test.py

@@ -0,0 +1,11 @@
+class TestClass:
+    def __init__(self):
+        self.message = "This is not a CSV or JSON file"
+
+    def display_message(self):
+        print(self.message)
+
+
+if __name__ == "__main__":
+    test_instance = TestClass()
+    test_instance.display_message()

tests/unit_tests/test_read_data.py

@@ -0,0 +1,33 @@
+import os
+
+import pytest
+
+from gcf_data_mapper.read import read_data_file
+
+
+@pytest.fixture(
+    params=[
+        "tests/unit_tests/test_fixtures/test.json",
+        "tests/unit_tests/test_fixtures/test.csv",
+    ]
+)
+def get_test_data(request):
+    """Fixture to yield expected data structure based on file type."""
+    file_path = request.param
+    assert os.path.exists(file_path)
+    yield read_data_file(file_path)
+
+
+def test_reads_files(get_test_data):
+    if isinstance(get_test_data, list):
+        data = read_data_file("tests/unit_tests/test_fixtures/test.csv")
+        assert get_test_data == data
+    elif isinstance(get_test_data, dict):
+        data = read_data_file("tests/unit_tests/test_fixtures/test.json")
+        assert get_test_data == data
+
+
+def test_errors_on_invalid_file():
+    with pytest.raises(ValueError) as e:
+        read_data_file("tests/unit_tests/test_fixtures/test.py")
+    assert str(e.value) == ("Error reading file: File must be a valid json or csv file")