#165: Make this repo pip installable

- As suggested by Alan, a top level directory is required to make this repo ready for production use. This is also required for Poetry

common/backends.py → datagateway_api/common/backends.py

@@ -1,7 +1,7 @@
-from common.database.backend import DatabaseBackend
-from common.icat.backend import PythonICATBackend
-from common.backend import Backend
-from common.config import config
+from datagateway_api.common.database.backend import DatabaseBackend
+from datagateway_api.common.icat.backend import PythonICATBackend
+from datagateway_api.common.backend import Backend
+from datagateway_api.common.config import config
 import sys
 
 backend_type = config.get_backend_type()

common/constants.py → datagateway_api/common/constants.py

@@ -1,4 +1,4 @@
-from common.config import config
+from datagateway_api.common.config import config
 
 
 class Constants:

common/database/backend.py → datagateway_api/common/database/backend.py

@@ -1,5 +1,5 @@
-from common.backend import Backend
-from common.database.helpers import (
+from datagateway_api.common.backend import Backend
+from datagateway_api.common.database.helpers import (
     get_facility_cycles_for_instrument,
     get_facility_cycles_for_instrument_count,
     get_investigations_for_instrument_in_facility_cycle,
@@ -15,10 +15,10 @@
     get_first_filtered_row,
     requires_session_id,
 )
-from common.helpers import queries_records
-from common.database.models import EntityHelper, SESSION
+from datagateway_api.common.helpers import queries_records
+from datagateway_api.common.database.models import EntityHelper, SESSION
 import uuid
-from common.exceptions import AuthenticationError
+from datagateway_api.common.exceptions import AuthenticationError
 import datetime
 
 import logging

common/database/filters.py → datagateway_api/common/database/filters.py

@@ -1,13 +1,13 @@
-from common.filters import (
+from datagateway_api.common.filters import (
     WhereFilter,
     DistinctFieldFilter,
     OrderFilter,
     SkipFilter,
     LimitFilter,
     IncludeFilter,
 )
-from common.exceptions import FilterError, MultipleIncludeError
-from common.database import models
+from datagateway_api.common.exceptions import FilterError, MultipleIncludeError
+from datagateway_api.common.database import models
 
 from sqlalchemy import asc, desc
 import logging

common/database/helpers.py → datagateway_api/common/database/helpers.py

@@ -5,29 +5,29 @@
 
 from sqlalchemy.orm import aliased
 
-from common.exceptions import (
+from datagateway_api.common.exceptions import (
     ApiError,
     AuthenticationError,
     MissingRecordError,
     FilterError,
     BadRequestError,
     MultipleIncludeError,
 )
-from common.database.models import (
+from datagateway_api.common.database.models import (
     INVESTIGATION,
     INSTRUMENT,
     FACILITYCYCLE,
     INVESTIGATIONINSTRUMENT,
     FACILITY,
     SESSION,
 )
-from common.database.session_manager import session_manager
-from common.filter_order_handler import FilterOrderHandler
-from common.config import config
+from datagateway_api.common.database.session_manager import session_manager
+from datagateway_api.common.filter_order_handler import FilterOrderHandler
+from datagateway_api.common.config import config
 
 backend_type = config.get_backend_type()
 if backend_type == "db":
-    from common.database.filters import (
+    from datagateway_api.common.database.filters import (
         DatabaseWhereFilter as WhereFilter,
         DatabaseDistinctFieldFilter as DistinctFieldFilter,
         DatabaseOrderFilter as OrderFilter,
@@ -36,7 +36,7 @@
         DatabaseIncludeFilter as IncludeFilter,
     )
 elif backend_type == "python_icat":
-    from common.icat.filters import (
+    from datagateway_api.common.icat.filters import (
         PythonICATWhereFilter as WhereFilter,
         PythonICATDistinctFieldFilter as DistinctFieldFilter,
         PythonICATOrderFilter as OrderFilter,

common/database/models.py → datagateway_api/common/database/models.py

@@ -20,7 +20,7 @@
 from sqlalchemy.orm import relationship
 from sqlalchemy.orm.collections import InstrumentedList
 
-from common.exceptions import FilterError, DatabaseError, ApiError
+from datagateway_api.common.exceptions import FilterError, DatabaseError, ApiError
 
 Base = declarative_base()
 

common/database/session_manager.py → datagateway_api/common/database/session_manager.py

@@ -2,7 +2,7 @@
 from sqlalchemy.orm import sessionmaker, scoped_session
 from sqlalchemy.pool import QueuePool
 
-from common.constants import Constants
+from datagateway_api.common.constants import Constants
 
 engine = create_engine(
     Constants.DATABASE_URL, poolclass=QueuePool, pool_size=100, max_overflow=0

common/date_handler.py → datagateway_api/common/date_handler.py

@@ -1,8 +1,8 @@
 from datetime import datetime
 from dateutil.parser import parse
 
-from common.exceptions import BadRequestError
-from common.constants import Constants
+from datagateway_api.common.exceptions import BadRequestError
+from datagateway_api.common.constants import Constants
 
 
 class DateHandler:

common/filter_order_handler.py → datagateway_api/common/filter_order_handler.py

@@ -1,6 +1,6 @@
 import logging
 
-from common.icat.filters import (
+from datagateway_api.common.icat.filters import (
     PythonICATLimitFilter,
     PythonICATSkipFilter,
     PythonICATOrderFilter,

common/filters.py → datagateway_api/common/filters.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 import logging
 
-from common.exceptions import BadRequestError
+from datagateway_api.common.exceptions import BadRequestError
 
 log = logging.getLogger()
 

common/helpers.py → datagateway_api/common/helpers.py

@@ -6,8 +6,8 @@
 from flask_restful import reqparse
 from sqlalchemy.exc import IntegrityError
 
-from common.database.helpers import QueryFilterFactory
-from common.exceptions import (
+from datagateway_api.common.database.helpers import QueryFilterFactory
+from datagateway_api.common.exceptions import (
     ApiError,
     AuthenticationError,
     FilterError,

common/icat/backend.py → datagateway_api/common/icat/backend.py

@@ -3,9 +3,9 @@
 import icat.client
 from icat.exception import ICATSessionError
 
-from common.backend import Backend
-from common.helpers import queries_records
-from common.icat.helpers import (
+from datagateway_api.common.backend import Backend
+from datagateway_api.common.helpers import queries_records
+from datagateway_api.common.icat.helpers import (
     requires_session_id,
     get_session_details_helper,
     logout_icat_client,
@@ -24,8 +24,8 @@
     get_investigations_for_instrument_in_facility_cycle_count,
 )
 
-from common.config import config
-from common.exceptions import AuthenticationError
+from datagateway_api.common.config import config
+from datagateway_api.common.exceptions import AuthenticationError
 
 log = logging.getLogger()
 

common/icat/filters.py → datagateway_api/common/icat/filters.py

@@ -1,16 +1,16 @@
 import logging
 
-from common.filters import (
+from datagateway_api.common.filters import (
     WhereFilter,
     DistinctFieldFilter,
     OrderFilter,
     SkipFilter,
     LimitFilter,
     IncludeFilter,
 )
-from common.exceptions import FilterError
-from common.config import config
-from common.constants import Constants
+from datagateway_api.common.exceptions import FilterError
+from datagateway_api.common.config import config
+from datagateway_api.common.constants import Constants
 
 log = logging.getLogger()
 

common/icat/helpers.py → datagateway_api/common/icat/helpers.py

@@ -11,17 +11,17 @@
     ICATNoObjectError,
     ICATParameterError,
 )
-from common.exceptions import (
+from datagateway_api.common.exceptions import (
     AuthenticationError,
     BadRequestError,
     MissingRecordError,
     PythonICATError,
 )
-from common.filter_order_handler import FilterOrderHandler
-from common.date_handler import DateHandler
-from common.constants import Constants
-from common.icat.filters import PythonICATLimitFilter, PythonICATWhereFilter
-from common.icat.query import ICATQuery
+from datagateway_api.common.filter_order_handler import FilterOrderHandler
+from datagateway_api.common.date_handler import DateHandler
+from datagateway_api.common.constants import Constants
+from datagateway_api.common.icat.filters import PythonICATLimitFilter, PythonICATWhereFilter
+from datagateway_api.common.icat.query import ICATQuery
 
 
 log = logging.getLogger()

common/icat/query.py → datagateway_api/common/icat/query.py

@@ -6,9 +6,9 @@
 from icat.query import Query
 from icat.exception import ICATValidationError, ICATInternalError
 
-from common.exceptions import PythonICATError, FilterError
-from common.date_handler import DateHandler
-from common.constants import Constants
+from datagateway_api.common.exceptions import PythonICATError, FilterError
+from datagateway_api.common.date_handler import DateHandler
+from datagateway_api.common.constants import Constants
 
 log = logging.getLogger()
 

common/logger_setup.py → datagateway_api/common/logger_setup.py

@@ -1,7 +1,7 @@
 import logging.config
 from pathlib import Path
 
-from common.config import config
+from datagateway_api.common.config import config
 
 log_level = "DEBUG"
 LOG_FILE_NAME = Path(__file__).parent.parent / "logs.log"

src/main.py → datagateway_api/src/main.py

@@ -3,28 +3,28 @@
 from flask_restful import Api
 from flask_swagger_ui import get_swaggerui_blueprint
 
-from common.config import config
-from common.logger_setup import setup_logger
-from src.resources.entities.entity_endpoint import (
+from datagateway_api.common.config import config
+from datagateway_api.common.logger_setup import setup_logger
+from datagateway_api.src.resources.entities.entity_endpoint import (
     get_endpoint,
     get_id_endpoint,
     get_count_endpoint,
     get_find_one_endpoint,
 )
-from src.resources.entities.entity_map import endpoints
-from src.resources.non_entities.sessions_endpoints import *
-from src.resources.table_endpoints.table_endpoints import (
+from datagateway_api.src.resources.entities.entity_map import endpoints
+from datagateway_api.src.resources.non_entities.sessions_endpoints import *
+from datagateway_api.src.resources.table_endpoints.table_endpoints import (
     InstrumentsFacilityCycles,
     InstrumentsFacilityCyclesCount,
     InstrumentsFacilityCyclesInvestigations,
     InstrumentsFacilityCyclesInvestigationsCount,
 )
-from common.exceptions import ApiError
+from datagateway_api.common.exceptions import ApiError
 from apispec import APISpec
 from pathlib import Path
 import json
-from src.swagger.apispec_flask_restful import RestfulPlugin
-from src.swagger.initialise_spec import initialise_spec
+from datagateway_api.src.swagger.apispec_flask_restful import RestfulPlugin
+from datagateway_api.src.swagger.initialise_spec import initialise_spec
 
 
 spec = APISpec(

src/resources/entities/entity_endpoint.py → datagateway_api/src/resources/entities/entity_endpoint.py

@@ -1,11 +1,11 @@
 from flask import request
 from flask_restful import Resource
 
-from common.helpers import (
+from datagateway_api.common.helpers import (
     get_session_id_from_auth_header,
     get_filters_from_query_string,
 )
-from common.backends import backend
+from datagateway_api.common.backends import backend
 
 
 def get_endpoint(name, entity_type):

src/resources/entities/entity_map.py → datagateway_api/src/resources/entities/entity_map.py

@@ -1,4 +1,4 @@
-from common.database.models import EntityHelper
+from datagateway_api.common.database.models import EntityHelper
 import datetime
 from sqlalchemy.inspection import inspect
 

src/resources/non_entities/sessions_endpoints.py → datagateway_api/src/resources/non_entities/sessions_endpoints.py

@@ -4,15 +4,15 @@
 from flask import request
 from flask_restful import Resource, reqparse
 
-from common.database.helpers import (
+from datagateway_api.common.database.helpers import (
     insert_row_into_table,
     delete_row_by_id,
     get_row_by_id,
 )
-from common.helpers import get_session_id_from_auth_header
-from common.database.models import SESSION
-from common.backends import backend
-from common.exceptions import AuthenticationError
+from datagateway_api.common.helpers import get_session_id_from_auth_header
+from datagateway_api.common.database.models import SESSION
+from datagateway_api.common.backends import backend
+from datagateway_api.common.exceptions import AuthenticationError
 
 log = logging.getLogger()
 

src/resources/table_endpoints/table_endpoints.py → datagateway_api/src/resources/table_endpoints/table_endpoints.py

@@ -1,16 +1,16 @@
 from flask_restful import Resource
 
-from common.database.helpers import (
+from datagateway_api.common.database.helpers import (
     get_facility_cycles_for_instrument,
     get_facility_cycles_for_instrument_count,
     get_investigations_for_instrument_in_facility_cycle,
     get_investigations_for_instrument_in_facility_cycle_count,
 )
-from common.helpers import (
+from datagateway_api.common.helpers import (
     get_session_id_from_auth_header,
     get_filters_from_query_string,
 )
-from common.backends import backend
+from datagateway_api.common.backends import backend
 
 
 class InstrumentsFacilityCycles(Resource):

src/swagger/initialise_spec.py → datagateway_api/src/swagger/initialise_spec.py

@@ -1,4 +1,4 @@
-from src.resources.entities.entity_map import create_entity_models
+from datagateway_api.src.resources.entities.entity_map import create_entity_models
 
 
 def initialise_spec(spec):

test/test_base.py

@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from src.main import app
+from datagateway_api.src.main import app
 
 
 class FlaskAppTest(TestCase):

test/test_database_helpers.py

@@ -1,12 +1,12 @@
 from unittest import TestCase
 
-from common.database.helpers import QueryFilterFactory
-from common.config import config
-from common.exceptions import ApiError
+from datagateway_api.common.database.helpers import QueryFilterFactory
+from datagateway_api.common.config import config
+from datagateway_api.common.exceptions import ApiError
 
 backend_type = config.get_backend_type()
 if backend_type == "db":
-    from common.database.filters import (
+    from datagateway_api.common.database.filters import (
         DatabaseWhereFilter as WhereFilter,
         DatabaseDistinctFieldFilter as DistinctFieldFilter,
         DatabaseOrderFilter as OrderFilter,
@@ -16,7 +16,7 @@
     )
 elif backend_type == "python_icat":
     # TODO - Adapt these tests for the ICAT implementation of filters
-    from common.icat.filters import (
+    from datagateway_api.common.icat.filters import (
         PythonICATWhereFilter as WhereFilter,
         PythonICATDistinctFieldFilter as DistinctFieldFilter,
         PythonICATOrderFilter as OrderFilter,

test/test_entityHelper.py

@@ -1,7 +1,7 @@
 import datetime
 from unittest import TestCase
 
-from common.database.models import DATAFILE, DATASET, DATAFILEFORMAT, INVESTIGATION
+from datagateway_api.common.database.models import DATAFILE, DATASET, DATAFILEFORMAT, INVESTIGATION
 
 
 class TestEntityHelper(TestCase):