change lib to src

Author: GabrielBarberini

Dockerfile

@@ -14,6 +14,6 @@ RUN apt-get update && \
     apt-get purge -y --auto-remove && \
     rm -rf /var/lib/apt/lists/*
 
-COPY ./lib /app/lib
+COPY ./src /app/src
 
-CMD ["gunicorn", "-c", "lib/settings/gunicorn.py", "-w", "1", "--threads=2", "-k", "uvicorn.workers.UvicornWorker", "lib.api:app", "--log-level", "Debug", "-b", "0.0.0.0:3000", "--timeout", "60"]
+CMD ["gunicorn", "-c", "src/settings/gunicorn.py", "-w", "1", "--threads=2", "-k", "uvicorn.workers.UvicornWorker", "src.api:app", "--log-level", "Debug", "-b", "0.0.0.0:3000", "--timeout", "60"]

Makefile

@@ -2,26 +2,26 @@ format: black ruff
 lint: flake8 pylint
 
 black:
-	black ./lib || true
+	black ./src || true
 	black ./tests || true
 
 flake8:
-	flake8 --ignore E501,E402,F401,W503,C0414 ./lib || true
+	flake8 --ignore E501,E402,F401,W503,C0414 ./src || true
 	flake8 --ignore E501,E402,F401,W503,C0414 ./tests || true
 
 pylint:
-	pylint ./lib || true
+	pylint ./src || true
 	pylint ./tests || true
 
 ruff:
-	ruff check --fix ./lib || true
+	ruff check --fix ./src || true
 	ruff check --fix ./tests || true
 
 test:
 	python3 -m pytest .
 
 dev:
-	python3 -m uvicorn lib:app --reload --port 3000
+	python3 -m uvicorn src.app --reload --port 3000
 
 clean:
 	docker stop infinity-api

README.md

@@ -25,8 +25,8 @@ $ touch .env && echo MONGODB_CONNECTION_STRING="$ConnectionString" > .env
 - run docker compose: `docker-compose up --build -d`
 
 ### Standalone 
-- Dev: `python3 -m uvicorn lib:app --reload --port 3000`
-- Prod: `gunicorn -k uvicorn.workers.UvicornWorker lib:app -b 0.0.0.0:3000`
+- Dev: `python3 -m uvicorn src:app --reload --port 3000`
+- Prod: `gunicorn -k uvicorn.workers.UvicornWorker src:app -b 0.0.0.0:3000`
 
 ## Project structure
 ```

lib/controllers/__init__.py

@@ -1,4 +1,4 @@
-# lib/__init__.py
+# src.__init__.py
 import logging
 import sys
 
@@ -25,6 +25,6 @@ def parse_error(error):
     return f"{exc_type}: {exc_obj}"
 
 
-from lib.api import (  # pylint: disable=wrong-import-position,cyclic-import,useless-import-alias
+from src.api import (  # pylint: disable=wrong-import-position,cyclic-import,useless-import-alias
     app as app,
 )

lib/repositories/__init__.py

@@ -1,5 +1,5 @@
 # __main__.py
-from lib.api import app
+from src.api import app
 
 if __name__ == '__main__':
     app.run()  # pylint: disable=no-member

lib/__init__.py renamed to src/__init__.py

@@ -6,9 +6,9 @@
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from opentelemetry.instrumentation.requests import RequestsInstrumentor
 
-from lib import logger, parse_error
-from lib.routes import flight, environment, motor, rocket
-from lib.utils import RocketPyGZipMiddleware
+from src import logger, parse_error
+from src.routes import flight, environment, motor, rocket
+from src.utils import RocketPyGZipMiddleware
 
 app = FastAPI(
     swagger_ui_parameters={

lib/__main__.py renamed to src/__main__.py

@@ -0,0 +1 @@
+# src.controllers/__init__.py

lib/api.py renamed to src/api.py

@@ -1,10 +1,10 @@
-from lib.controllers.interface import (
+from src.controllers.interface import (
     ControllerInterface,
     controller_exception_handler,
 )
-from lib.views.environment import EnvironmentSimulation
-from lib.models.environment import EnvironmentModel
-from lib.services.environment import EnvironmentService
+from src.views.environment import EnvironmentSimulation
+from src.models.environment import EnvironmentModel
+from src.services.environment import EnvironmentService
 
 
 class EnvironmentController(ControllerInterface):

src/controllers/__init__.py

@@ -1,12 +1,12 @@
-from lib.controllers.interface import (
+from src.controllers.interface import (
     ControllerInterface,
     controller_exception_handler,
 )
-from lib.views.flight import FlightSimulation
-from lib.models.flight import FlightModel
-from lib.models.environment import EnvironmentModel
-from lib.models.rocket import RocketModel
-from lib.services.flight import FlightService
+from src.views.flight import FlightSimulation
+from src.models.flight import FlightModel
+from src.models.environment import EnvironmentModel
+from src.models.rocket import RocketModel
+from src.services.flight import FlightService
 
 
 class FlightController(ControllerInterface):

lib/controllers/environment.py renamed to src/controllers/environment.py

@@ -3,10 +3,10 @@
 from pymongo.errors import PyMongoError
 from fastapi import HTTPException, status
 
-from lib import logger
-from lib.models.interface import ApiBaseModel
-from lib.views.interface import ApiBaseView
-from lib.repositories.interface import RepositoryInterface
+from src import logger
+from src.models.interface import ApiBaseModel
+from src.views.interface import ApiBaseView
+from src.repositories.interface import RepositoryInterface
 
 
 def controller_exception_handler(method):

lib/controllers/flight.py renamed to src/controllers/flight.py

@@ -1,10 +1,10 @@
-from lib.controllers.interface import (
+from src.controllers.interface import (
     ControllerInterface,
     controller_exception_handler,
 )
-from lib.views.motor import MotorSimulation
-from lib.models.motor import MotorModel
-from lib.services.motor import MotorService
+from src.views.motor import MotorSimulation
+from src.models.motor import MotorModel
+from src.services.motor import MotorService
 
 
 class MotorController(ControllerInterface):

lib/controllers/interface.py renamed to src/controllers/interface.py

@@ -1,10 +1,10 @@
-from lib.controllers.interface import (
+from src.controllers.interface import (
     ControllerInterface,
     controller_exception_handler,
 )
-from lib.views.rocket import RocketSimulation
-from lib.models.rocket import RocketModel
-from lib.services.rocket import RocketService
+from src.views.rocket import RocketSimulation
+from src.models.rocket import RocketModel
+from src.services.rocket import RocketService
 
 
 class RocketController(ControllerInterface):

lib/controllers/motor.py renamed to src/controllers/motor.py

@@ -1,6 +1,6 @@
 import datetime
 from typing import Optional, ClassVar, Self, Literal
-from lib.models.interface import ApiBaseModel
+from src.models.interface import ApiBaseModel
 
 
 class EnvironmentModel(ApiBaseModel):
@@ -34,13 +34,13 @@ def DELETED():
 
     @staticmethod
     def CREATED(model_id: str):
-        from lib.views.environment import EnvironmentCreated
+        from src.views.environment import EnvironmentCreated
 
         return EnvironmentCreated(environment_id=model_id)
 
     @staticmethod
     def RETRIEVED(model_instance: type(Self)):
-        from lib.views.environment import EnvironmentRetrieved, EnvironmentView
+        from src.views.environment import EnvironmentRetrieved, EnvironmentView
 
         return EnvironmentRetrieved(
             environment=EnvironmentView(

lib/controllers/rocket.py renamed to src/controllers/rocket.py

@@ -1,7 +1,7 @@
 from typing import Optional, Self, ClassVar, Literal
-from lib.models.interface import ApiBaseModel
-from lib.models.rocket import RocketModel
-from lib.models.environment import EnvironmentModel
+from src.models.interface import ApiBaseModel
+from src.models.rocket import RocketModel
+from src.models.environment import EnvironmentModel
 
 
 class FlightModel(ApiBaseModel):
@@ -54,13 +54,13 @@ def DELETED():
 
     @staticmethod
     def CREATED(model_id: str):
-        from lib.views.flight import FlightCreated
+        from src.views.flight import FlightCreated
 
         return FlightCreated(flight_id=model_id)
 
     @staticmethod
     def RETRIEVED(model_instance: type(Self)):
-        from lib.views.flight import FlightRetrieved, FlightView
+        from src.views.flight import FlightRetrieved, FlightView
 
         return FlightRetrieved(
             flight=FlightView(

lib/models/environment.py renamed to src/models/environment.py

@@ -2,8 +2,8 @@
 from typing import Optional, Tuple, List, Union, Self, ClassVar, Literal
 from pydantic import PrivateAttr, model_validator, computed_field
 
-from lib.models.interface import ApiBaseModel
-from lib.models.sub.tanks import MotorTank
+from src.models.interface import ApiBaseModel
+from src.models.sub.tanks import MotorTank
 
 
 class MotorKinds(str, Enum):
@@ -90,13 +90,13 @@ def DELETED():
 
     @staticmethod
     def CREATED(model_id: str):
-        from lib.views.motor import MotorCreated
+        from src.views.motor import MotorCreated
 
         return MotorCreated(motor_id=model_id)
 
     @staticmethod
     def RETRIEVED(model_instance: type(Self)):
-        from lib.views.motor import MotorRetrieved, MotorView
+        from src.views.motor import MotorRetrieved, MotorView
 
         return MotorRetrieved(
             motor=MotorView(

lib/models/flight.py renamed to src/models/flight.py

@@ -1,7 +1,7 @@
 from typing import Optional, Tuple, List, Union, Self, ClassVar, Literal
-from lib.models.interface import ApiBaseModel
-from lib.models.motor import MotorModel
-from lib.models.sub.aerosurfaces import (
+from src.models.interface import ApiBaseModel
+from src.models.motor import MotorModel
+from src.models.sub.aerosurfaces import (
     Fins,
     NoseCone,
     Tail,
@@ -47,13 +47,13 @@ def DELETED():
 
     @staticmethod
     def CREATED(model_id: str):
-        from lib.views.rocket import RocketCreated
+        from src.views.rocket import RocketCreated
 
         return RocketCreated(rocket_id=model_id)
 
     @staticmethod
     def RETRIEVED(model_instance: type(Self)):
-        from lib.views.rocket import RocketRetrieved, RocketView
+        from src.views.rocket import RocketRetrieved, RocketView
 
         return RocketRetrieved(
             rocket=RocketView(

lib/models/interface.py renamed to src/models/interface.py

@@ -0,0 +1 @@
+# src/controllers/__init__.py

lib/models/motor.py renamed to src/models/motor.py

@@ -1,6 +1,6 @@
 from typing import Optional
-from lib.models.environment import EnvironmentModel
-from lib.repositories.interface import (
+from src.models.environment import EnvironmentModel
+from src.repositories.interface import (
     RepositoryInterface,
     repository_exception_handler,
 )

lib/models/rocket.py renamed to src/models/rocket.py

@@ -1,6 +1,6 @@
 from typing import Optional
-from lib.models.flight import FlightModel
-from lib.repositories.interface import (
+from src.models.flight import FlightModel
+from src.repositories.interface import (
     RepositoryInterface,
     repository_exception_handler,
 )

lib/models/sub/aerosurfaces.py renamed to src/models/sub/aerosurfaces.py

@@ -16,9 +16,9 @@
 from fastapi import HTTPException, status
 from bson import ObjectId
 
-from lib import logger
-from lib.secrets import Secrets
-from lib.models.interface import ApiBaseModel
+from src import logger
+from src.secrets import Secrets
+from src.models.interface import ApiBaseModel
 
 
 def not_implemented(*args, **kwargs):

lib/models/sub/tanks.py renamed to src/models/sub/tanks.py

@@ -1,6 +1,6 @@
 from typing import Optional
-from lib.models.motor import MotorModel
-from lib.repositories.interface import (
+from src.models.motor import MotorModel
+from src.repositories.interface import (
     RepositoryInterface,
     repository_exception_handler,
 )

src/repositories/__init__.py

@@ -1,6 +1,6 @@
 from typing import Optional
-from lib.models.rocket import RocketModel
-from lib.repositories.interface import (
+from src.models.rocket import RocketModel
+from src.repositories.interface import (
     RepositoryInterface,
     repository_exception_handler,
 )

lib/repositories/environment.py renamed to src/repositories/environment.py

@@ -5,13 +5,13 @@
 from fastapi import APIRouter, Response
 from opentelemetry import trace
 
-from lib.views.environment import (
+from src.views.environment import (
     EnvironmentSimulation,
     EnvironmentCreated,
     EnvironmentRetrieved,
 )
-from lib.models.environment import EnvironmentModel
-from lib.controllers.environment import EnvironmentController
+from src.models.environment import EnvironmentModel
+from src.controllers.environment import EnvironmentController
 
 router = APIRouter(
     prefix="/environments",

lib/repositories/flight.py renamed to src/repositories/flight.py

@@ -5,16 +5,16 @@
 from fastapi import APIRouter, Response
 from opentelemetry import trace
 
-from lib.views.flight import (
+from src.views.flight import (
     FlightSimulation,
     FlightCreated,
     FlightRetrieved,
 )
-from lib.models.environment import EnvironmentModel
-from lib.models.flight import FlightModel
-from lib.models.rocket import RocketModel
-from lib.models.motor import MotorKinds
-from lib.controllers.flight import FlightController
+from src.models.environment import EnvironmentModel
+from src.models.flight import FlightModel
+from src.models.rocket import RocketModel
+from src.models.motor import MotorKinds
+from src.controllers.flight import FlightController
 
 router = APIRouter(
     prefix="/flights",

lib/repositories/interface.py renamed to src/repositories/interface.py

@@ -5,13 +5,13 @@
 from fastapi import APIRouter, Response
 from opentelemetry import trace
 
-from lib.views.motor import (
+from src.views.motor import (
     MotorSimulation,
     MotorCreated,
     MotorRetrieved,
 )
-from lib.models.motor import MotorModel, MotorKinds
-from lib.controllers.motor import MotorController
+from src.models.motor import MotorModel, MotorKinds
+from src.controllers.motor import MotorController
 
 router = APIRouter(
     prefix="/motors",