Modify Python Structure so that we treat src as a package (#1207)

Author: grahamalama

.github/workflows/pr_checks_backend.yml

@@ -70,7 +70,7 @@ jobs:
 
       - name: Run Pytest
         working-directory: data/src
-        run: PYTHONPATH=$PYTHONPATH:. pipenv run pytest
+        run: pipenv run pytest
 
   run-formatter:
     runs-on: ubuntu-latest

data/Dockerfile

@@ -30,7 +30,7 @@ ENV GDAL_CONFIG=/usr/bin/gdal-config
 RUN pip install pipenv
 
 # Copy the Pipfile and Pipfile.lock from the src directory
-COPY src/Pipfile src/Pipfile.lock ./
+COPY Pipfile Pipfile.lock ./
 
 # update pipfile
 RUN pipenv lock

data/src/Pipfile data/Pipfiledata/src/Pipfile renamed to data/Pipfile

@@ -6,15 +6,15 @@
 import sqlalchemy as sa
 from sqlalchemy import inspect
 
-from classes.featurelayer import google_cloud_bucket
-from config.config import (
+from src.classes.featurelayer import google_cloud_bucket
+from src.config.config import (
     log_level,
     max_backup_schema_days,
     tile_file_backup_directory,
     tiles_file_id_prefix,
 )
-from config.psql import conn, local_engine, url
-from data_utils.utils import mask_password
+from src.config.psql import conn, local_engine, url
+from src.data_utils.utils import mask_password
 
 log.basicConfig(level=log_level)
 

data/src/Pipfile.lock data/Pipfile.lockdata/src/Pipfile.lock renamed to data/Pipfile.lock

@@ -3,7 +3,7 @@
 
 from google.cloud import storage
 
-from config.config import log_level
+from src.config.config import log_level
 
 log.basicConfig(level=log_level)
 

data/src/classes/backup_archive_database.py

@@ -7,17 +7,17 @@
 
 from slack_sdk import WebClient
 
-from classes.backup_archive_database import backup_schema_name
-from classes.featurelayer import google_cloud_bucket
-from config.config import (
+from src.classes.backup_archive_database import backup_schema_name
+from src.classes.featurelayer import google_cloud_bucket
+from src.config.config import (
     from_email,
     log_level,
     report_to_email,
     report_to_slack_channel,
     smtp_server,
 )
-from config.psql import conn, url
-from data_utils.utils import mask_password
+from src.config.psql import conn, url
+from src.data_utils.utils import mask_password
 
 log.basicConfig(level=log_level)
 

data/src/classes/bucket_manager.py

@@ -11,15 +11,15 @@
 from google.cloud import storage
 from shapely import Point, wkb
 
-from classes.bucket_manager import GCSBucketManager
-from config.config import (
+from src.classes.bucket_manager import GCSBucketManager
+from src.config.config import (
     FORCE_RELOAD,
     USE_CRS,
     log_level,
     min_tiles_file_size_in_bytes,
     write_production_tiles_file,
 )
-from config.psql import conn, local_engine
+from src.config.psql import conn, local_engine
 
 log.basicConfig(level=log_level)
 
@@ -283,7 +283,7 @@ def build_and_publish(self, tiles_file_id_prefix: str) -> None:
         Builds PMTiles and a Parquet file from a GeoDataFrame and publishes them to Google Cloud Storage.
 
         Args:
-            tiles_file_id_prefix (str): The ID prefix used for naming the PMTiles and Parquet files, coming from config.
+            tiles_file_id_prefix (str): The ID prefix used for naming the PMTiles and Parquet files, coming from src.config.
 
         Raises:
             ValueError: Raised if the generated PMTiles file is smaller than the minimum allowed size, indicating a potential corruption or incomplete file.

data/src/classes/diff_report.py

@@ -2,7 +2,7 @@
 
 from sqlalchemy import create_engine
 
-from config.config import is_docker
+from src.config.config import is_docker
 
 
 def get_db_url():

data/src/classes/featurelayer.py

@@ -1,5 +1,5 @@
-from classes.featurelayer import FeatureLayer
-from constants.services import CITY_OWNED_PROPERTIES_TO_LOAD
+from src.classes.featurelayer import FeatureLayer
+from src.constants.services import CITY_OWNED_PROPERTIES_TO_LOAD
 
 
 def city_owned_properties(primary_featurelayer: FeatureLayer) -> FeatureLayer: