Merge pull request #214 from atlanticwave-sdx/213.rename-swagger-server

Rename `swagger_server` to `sdx_controller`

.github/workflows/checks.yml

@@ -18,10 +18,10 @@ jobs:
     steps:
 
       - name: Check out sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python 3.9
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.9"
           cache: "pip"  # cache pip dependencies

.github/workflows/images.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Collect metadata for container image tags
       # See https://github.com/docker/metadata-action

.github/workflows/test.yml

@@ -48,10 +48,10 @@ jobs:
     steps:
 
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'  # cache pip dependencies

.gitignore

@@ -136,4 +136,4 @@ dmypy.json
 /*.sqlite3-wal
 
 /db/*
-/swagger_server/_version.py
+/sdx_controller/_version.py

README.md

@@ -140,7 +140,7 @@ $ python3 -m venv venv --upgrade-deps
 $ source ./venv/bin/activate
 $ pip3 install [--editable] .
 $ source .env
-$ python3 -m swagger_server
+$ python3 -m sdx_controller
 ```
 
 ### Test topology files and connection requests

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "setuptools >= 61.0",
-    # "setuptools-scm >= 6.2",
+    "setuptools-scm >= 6.2",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -53,31 +53,31 @@ lint = [
 where = "swagger_server"
 
 [tool.setuptools]
-packages = ["swagger_server", "bapm_server"]
+packages = ["sdx_controller", "bapm_server"]
 
 [tool.setuptools_scm]
 # Write version info collected from git to a file.  This happens when
-# we run `python -m build`.
-write_to = "swagger_server/_version.py"
+# during package build step.
+write_to = "sdx_controller/_version.py"
 
 [tool.black]
 include = '\.py?$'
 
 [tool.isort]
 profile = "black"
-src_paths = ["swagger_server", "bapm_server"]
+src_paths = ["sdx_controller", "bapm_server"]
 
 [tool.coverage.run]
 branch = true
-omit = [ "swagger_server/test/*" ]
+omit = [ "sdx_controller/test/*" ]
 relative_files = true
 
 # The section below will let us have relative paths in test coverage
 # report. See https://hynek.me/articles/testing-packaging/
 [tool.coverage.paths]
 source = [
     # In checkouts.
-    "swagger_server/",
+    "sdx_controller/",
     "bapm_server/",
     # In installed paths.
     "**/site-packages/",

swagger_server/__main__.py → sdx_controller/__main__.py

@@ -8,9 +8,9 @@
 import connexion
 from sdx_pce.topology.manager import TopologyManager
 
-from swagger_server import encoder
-from swagger_server.messaging.rpc_queue_consumer import RpcConsumer
-from swagger_server.utils.db_utils import DbUtils
+from sdx_controller import encoder
+from sdx_controller.messaging.rpc_queue_consumer import RpcConsumer
+from sdx_controller.utils.db_utils import DbUtils
 
 logger = logging.getLogger(__name__)
 logging.getLogger("pika").setLevel(logging.WARNING)

swagger_server/controllers/connection_controller.py → sdx_controller/controllers/connection_controller.py

@@ -3,8 +3,8 @@
 
 import connexion
 
-from swagger_server.handlers.connection_handler import ConnectionHandler
-from swagger_server.utils.db_utils import DbUtils
+from sdx_controller.handlers.connection_handler import ConnectionHandler
+from sdx_controller.utils.db_utils import DbUtils
 
 LOG_FORMAT = (
     "%(levelname) -10s %(asctime)s %(name) -30s %(funcName) "

swagger_server/controllers/topology_controller.py → sdx_controller/controllers/topology_controller.py

@@ -3,7 +3,7 @@
 from sdx_pce.topology.grenmlconverter import GrenmlConverter
 from sdx_pce.topology.manager import TopologyManager
 
-from swagger_server.utils.db_utils import DbUtils
+from sdx_controller.utils.db_utils import DbUtils
 
 # Get DB connection and tables set up.
 db_instance = DbUtils()

swagger_server/controllers/user_controller.py → sdx_controller/controllers/user_controller.py

@@ -1,6 +1,6 @@
 import connexion
 
-from swagger_server.models.user import User  # noqa: E501
+from sdx_controller.models.user import User  # noqa: E501
 
 
 def create_user(body):  # noqa: E501

swagger_server/encoder.py → sdx_controller/encoder.py

@@ -1,7 +1,7 @@
 import six
 from connexion.apps.flask_app import FlaskJSONEncoder
 
-from swagger_server.models.base_model_ import Model
+from sdx_controller.models.base_model_ import Model
 
 
 class JSONEncoder(FlaskJSONEncoder):

swagger_server/handlers/connection_handler.py → sdx_controller/handlers/connection_handler.py

@@ -5,9 +5,9 @@
 from sdx_pce.load_balancing.te_solver import TESolver
 from sdx_pce.topology.temanager import TEManager
 
-from swagger_server.messaging.topic_queue_producer import TopicQueueProducer
-from swagger_server.models.simple_link import SimpleLink
-from swagger_server.utils.parse_helper import ParseHelper
+from sdx_controller.messaging.topic_queue_producer import TopicQueueProducer
+from sdx_controller.models.simple_link import SimpleLink
+from sdx_controller.utils.parse_helper import ParseHelper
 
 logger = logging.getLogger(__name__)
 logging.getLogger("pika").setLevel(logging.WARNING)

swagger_server/handlers/lc_message_handler.py → sdx_controller/handlers/lc_message_handler.py

@@ -1,8 +1,8 @@
 import json
 import logging
 
-from swagger_server.handlers.connection_handler import ConnectionHandler
-from swagger_server.utils.parse_helper import ParseHelper
+from sdx_controller.handlers.connection_handler import ConnectionHandler
+from sdx_controller.utils.parse_helper import ParseHelper
 
 logger = logging.getLogger(__name__)
 

swagger_server/messaging/rpc_queue_consumer.py → sdx_controller/messaging/rpc_queue_consumer.py

@@ -7,8 +7,8 @@
 
 import pika
 
-from swagger_server.handlers.lc_message_handler import LcMessageHandler
-from swagger_server.utils.parse_helper import ParseHelper
+from sdx_controller.handlers.lc_message_handler import LcMessageHandler
+from sdx_controller.utils.parse_helper import ParseHelper
 
 MQ_HOST = os.environ.get("MQ_HOST")
 # subscribe to the corresponding queue

sdx_controller/models/__init__.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# flake8: noqa
+from __future__ import absolute_import
+
+# import models into model package
+from sdx_controller.models.api_response import ApiResponse
+from sdx_controller.models.connection import Connection
+from sdx_controller.models.link import Link
+from sdx_controller.models.location import Location
+from sdx_controller.models.node import Node
+from sdx_controller.models.port import Port
+from sdx_controller.models.topology import Topology
+from sdx_controller.models.user import User

swagger_server/models/api_response.py → sdx_controller/models/api_response.py

@@ -5,8 +5,8 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
 
 
 class ApiResponse(Model):

swagger_server/models/base_model_.py → sdx_controller/models/base_model_.py

@@ -3,7 +3,7 @@
 
 import six
 
-from swagger_server import util
+from sdx_controller import util
 
 T = typing.TypeVar("T")
 

swagger_server/models/connection.py → sdx_controller/models/connection.py

@@ -5,9 +5,9 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
-from swagger_server.models.port import Port  # noqa: F401,E501
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
+from sdx_controller.models.port import Port  # noqa: F401,E501
 
 
 class Connection(Model):

swagger_server/models/link.py → sdx_controller/models/link.py

@@ -5,9 +5,9 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
-from swagger_server.models.port import Port  # noqa: F401,E501
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
+from sdx_controller.models.port import Port  # noqa: F401,E501
 
 
 class Link(Model):

swagger_server/models/location.py → sdx_controller/models/location.py

@@ -5,8 +5,8 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
 
 
 class Location(Model):

swagger_server/models/node.py → sdx_controller/models/node.py

@@ -5,10 +5,10 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
-from swagger_server.models.location import Location  # noqa: F401,E501
-from swagger_server.models.port import Port  # noqa: F401,E501
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
+from sdx_controller.models.location import Location  # noqa: F401,E501
+from sdx_controller.models.port import Port  # noqa: F401,E501
 
 
 class Node(Model):

swagger_server/models/port.py → sdx_controller/models/port.py

@@ -5,8 +5,8 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
 
 
 class Port(Model):

swagger_server/models/topology.py → sdx_controller/models/topology.py

@@ -5,10 +5,10 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
-from swagger_server.models.link import Link  # noqa: F401,E501
-from swagger_server.models.node import Node  # noqa: F401,E501
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
+from sdx_controller.models.link import Link  # noqa: F401,E501
+from sdx_controller.models.node import Node  # noqa: F401,E501
 
 
 class Topology(Model):

swagger_server/models/user.py → sdx_controller/models/user.py

@@ -5,8 +5,8 @@
 from datetime import date, datetime  # noqa: F401
 from typing import Dict, List  # noqa: F401
 
-from swagger_server import util
-from swagger_server.models.base_model_ import Model
+from sdx_controller import util
+from sdx_controller.models.base_model_ import Model
 
 
 class User(Model):