feat : 322 - list of locations (api) (#348)

* feat (partial): checks spreadsheet cities against placenames api. currently not properly set up to use list of cities

* feat: prints out list of communities that we are looking for and a list of communities found with the api

* chore: cleanup

* removes extra line

* chore: removes uneccessary line

* chore: refines function , adds logic for missing names, moves feature types to constant

* chore: fixes how communities are returned

django/api/bcngws_constants.py

@@ -0,0 +1,22 @@
+class FEATURES():
+    features_list = [
+        "Canadian Forces Base",
+        "Canadian Forces Station",
+        "City",
+        "Community",
+        "District Municipality (1)",
+        "First Nation Village",
+        "Former Locality",
+        "Indian Government District",
+        "Indian Government District : Land Unit",
+        "Indian Reserve-Réserve indienne",
+        "Locality",
+        "Recreation Facility",
+        "Recreational Community",
+        "Region",
+        "Regional District",
+        "Resort Municipality",
+        "Urban Community",
+        "Village (1)",
+        "Town"
+        ]

django/api/services/bcngws.py

@@ -0,0 +1,34 @@
+import requests
+from django.conf import settings
+from api.bcngws_constants import FEATURES
+
+
+def get_placename_matches(names_list, page_size, start_index, result):
+    names_string = ", ".join(map(str, names_list))
+
+    query = {
+        'outputFormat': 'json',
+        'name': names_string,
+        'itemsPerPage': 200,
+        'startIndex': start_index,
+        'exactSpelling': 0
+    }
+
+    try:
+        response = requests.get(settings.PLACENAMES_ENDPOINT, params=query)
+        response.raise_for_status()  # Raise an exception for HTTP errors (4xx or 5xx)
+        response = response.json()
+
+        filtered_names = [
+            feature['properties']['name']
+            for feature in response['features']
+            if feature['properties']['featureType'] in FEATURES.features_list
+        ]
+
+        result.extend(filtered_names)
+
+        if response['properties']['totalResults'] >= start_index + page_size:
+            get_placename_matches(names_list, page_size, start_index + page_size, result)
+
+    except requests.RequestException as e:
+        print(f"Error fetching data: {e}")

django/api/services/spreadsheet_uploader.py

@@ -4,7 +4,7 @@
 import pandas as pd
 import traceback
 from django.db import transaction
-from api.services.spreadsheet_uploader_prep import typo_checker
+from api.services.spreadsheet_uploader_prep import typo_checker, location_checker
 
 def get_field_default(model, field):
     field = model._meta.get_field(field)
@@ -160,6 +160,9 @@ def import_from_xls(
         if check_for_warnings:
             ## do the error checking
             typo_warnings = typo_checker(df, df['applicant_name'].dropna(), .8)
+            locations, names_from_spreadsheet = location_checker(df)
+            locations_set = set(locations)
+            names_without_match = [item for item in names_from_spreadsheet if item not in locations_set]
             if typo_warnings:
                 return {
                 "success": True,

django/api/services/spreadsheet_uploader_prep.py

@@ -2,6 +2,7 @@
 import numpy as np
 import pandas as pd
 import difflib as dl
+from api.services.bcngws import get_placename_matches
 
 def prepare_arc_project_tracking(df):
     df["Publicly Announced"] = df["Publicly Announced"].replace(
@@ -238,3 +239,11 @@ def typo_checker(df, s, c=0.7):
         return match_dict
     else:
         print('No issues')
+
+def location_checker(df):
+    # get list of unique locations from df
+    names =df['city'].unique()
+    communities = []
+    # send request to api with list of names, returns all the communities that somewhat matched
+    get_placename_matches(names, 200, 1, communities)
+    return communities, names

django/api/settings.py

@@ -228,3 +228,5 @@
         },
     },
 }
+
+PLACENAMES_ENDPOINT = PLACENAMES_ENDPOINT =  os.getenv("PLACENAMES_ENDPOINT", "https://apps.gov.bc.ca/pub/bcgnws/names/search")