Farewell Marktgasse

Author: MrMatAP

.idea/mrmat-python-api-flask.iml

@@ -30,38 +30,37 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "rich~=12.6.0",
-    "Flask~=2.2.2",
-    "Flask-SQLAlchemy~=3.0.2",
-    "Flask-Migrate~=4.0.0",
-    "flask-smorest~=0.40.0",
-    "Flask-Marshmallow~=0.14.0",
-    "marshmallow-sqlalchemy~=0.28.1",
-    "psycopg2-binary~=2.9.5",
-    "Flask-OIDC~=1.4.0"
+    "Flask~=2.2.3",                     # BSD 3-Clause
+    "Flask-SQLAlchemy~=3.0.3",          # BSD 3-Clause
+    "Flask-Migrate~=4.0.4",             # MIT
+    "flask-smorest~=0.40.0",            # MIT
+    "Flask-Marshmallow~=0.14.0",        # MIT
+    "marshmallow-sqlalchemy~=0.28.1",   # MIT
+    "psycopg2-binary~=2.9.5",           # LGPL with exceptions
+    "Flask-OIDC~=1.4.0",                # MIT
+    "itsdangerous<=2.0.1"               # BSD 3-Clause      Must affix so JSONWebSignatureSerializer is known
 ]
 dynamic = ["version"]
 
 [tool.setuptools.dynamic]
 version = { attr = "ci.version "}
 
 [tool.setuptools.packages.find]
-where = ["src/python"]
+where = ["src"]
 include = ["mrmat_python_api_flask*"]
 namespaces = true
 
 [tool.setuptools.package-data]
 "*" = ["*.mo", "migrations/*", "templates/*", "static/*"]
 
 [project.scripts]
-mrmat-python-api-flask = "mrmat_python_api_flask.cui:main"
 mrmat-python-api-flask-client = "mrmat_python_api_flask.client:main"
 
 # If you are debugging your tests using PyCharm then comment out the coverage options
 # in addopts
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "--cov=mrmat_python_api_flask --cov-report=term --cov-report=xml:build/coverage.xml --junit-xml=build/junit.xml"
+#addopts = "--cov=mrmat_python_api_flask --cov-report=term --cov-report=xml:build/coverage.xml --junit-xml=build/junit.xml"
 testpaths = ["tests"]
 junit_family = "xunit2"
 log_cli = 1

.idea/runConfigurations/cui.xml

@@ -6,26 +6,22 @@
 # Build/Test requirements
 
 setuptools>=42.0.0
-build>=0.9.0             # MIT
-wheel>=0.36.0            # MIT
-pylint~=2.15.5           # MIT
-pytest~=7.2.0            # GPL-2.0-or-later
+build>=0.10.0            # MIT
+wheel>=0.38.4            # MIT
+pylint~=2.15.10          # MIT
+pytest~=7.2.1            # GPL-2.0-or-later
 pytest-cov~=4.0.0        # MIT
 pyjwt~=2.6.0             # MIT
-python-keycloak~=2.6.0   # MIT
+python-keycloak~=2.6.1   # MIT
 
 # Runtime requirements
 
-rich~=12.6.0                    # MIT
-Flask~=2.2.2                    # BSD 3-Clause
-Flask-SQLAlchemy~=3.0.2         # BSD 3-Clause
-Flask-Migrate~=4.0.0            # MIT
+Flask~=2.2.3                    # BSD 3-Clause
+Flask-SQLAlchemy~=3.0.3         # BSD 3-Clause
+Flask-Migrate~=4.0.4            # MIT
 flask-smorest~=0.40.0           # MIT
 Flask-Marshmallow~=0.14.0       # MIT
 marshmallow-sqlalchemy~=0.28.1  # MIT
 psycopg2-binary~=2.9.5          # LGPL with exceptions
 Flask-OIDC~=1.4.0               # MIT
-
-# Do we need these?
-#requests_oauthlib~=1.3.1        # ISC
 itsdangerous<=2.0.1             # BSD 3-Clause      Must affix so JSONWebSignatureSerializer is known

.idea/runConfigurations/mrmat_python_api_flask__local_infrastructure_.xml

@@ -35,10 +35,8 @@
 from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
 from flask_marshmallow import Marshmallow
-from flask_oidc import OpenIDConnect
 from flask_smorest import Api
-
-log = logging.getLogger(__name__)
+from authlib.integrations.flask_client import OAuth
 
 #
 # Establish consistent logging
@@ -51,15 +49,16 @@
 except importlib.metadata.PackageNotFoundError:
     # You have not yet installed this as a package, likely because you're hacking on it in some IDE
     __version__ = '0.0.0.dev0'
+__app_version_header__ = 'X-MrMat-Python-API-Flask-Version'
 
 #
 # Initialize supporting services
 
 db = SQLAlchemy()
 ma = Marshmallow()
 migrate = Migrate()
-oidc = OpenIDConnect()
 api = Api()
+oauth = OAuth()
 
 
 def create_app(config_override=None, instance_path=None):
@@ -93,55 +92,59 @@ def create_app(config_override=None, instance_path=None):
     app.config.setdefault('OPENAPI_JSON_PATH', '/openapi.json')
     app.config.setdefault('OPENAPI_SWAGGER_UI_PATH', '/swagger-ui')
     app.config.setdefault('OPENAPI_SWAGGER_UI_URL', 'https://cdn.jsdelivr.net/npm/[email protected]/')
-    app_config_file = os.path.expanduser(os.environ.get('APP_CONFIG', '~/etc/mrmat-python-api-flask.json'))
+    app_config_file = os.environ.get('APP_CONFIG', os.path.expanduser('~/etc/mrmat-python-api-flask.json'))
     if os.path.exists(app_config_file):
-        log.info('Applying configuration from %s', app_config_file)
+        app.logger.info('Applying configuration from %s', app_config_file)
         with open(app_config_file, 'r', encoding='UTF-8') as c:
             config = json.load(c)
             app.config.from_object(config)
-            #app.config.from_json(app_config_file)
     if config_override is not None:
         for override in config_override:
-            log.info('Overriding configuration for %s from the command line', override)
+            app.logger.info('Overriding configuration for %s from the command line', override)
         app.config.from_mapping(config_override)
     if app.config['SECRET_KEY'] is None:
-        log.warning('Generating new secret key')
+        app.logger.warning('Generating new secret key')
         app.config['SECRET_KEY'] = secrets.token_urlsafe(16)
 
     #
     # Create the instance folder if it does not exist
 
     try:
         if not os.path.exists(app.instance_path):
-            log.info('Creating new instance path at %s', app.instance_path)
+            app.logger.info('Creating new instance path at %s', app.instance_path)
             os.makedirs(app.instance_path)
         else:
-            log.info('Using existing instance path at %s', app.instance_path)
+            app.logger.info('Using existing instance path at %s', app.instance_path)
     except OSError:
-        log.error('Failed to create new instance path at %s', app.instance_path)
+        app.logger.error('Failed to create new instance path at %s', app.instance_path)
         sys.exit(1)
 
-    # When using Flask-SQLAlchemy, there is no need to explicitly import DAO classes because they themselves
-    # inherit from the SQLAlchemy model
+    # There is no need to explicitly load DAO classes here because they inherit from the SQLAlchemy model
 
     db.init_app(app)
     migrate.init_app(app, db)
     ma.init_app(app)
     api.init_app(app)
-    if 'OIDC_CLIENT_SECRETS' in app.config.keys():
-        oidc.init_app(app)
-    else:
-        log.warning('Running without any authentication/authorisation')
+    oauth.init_app(app)
+    oauth.register(name='mrmat',
+                   server_metadata_url='http://localhost:5001/.well-known/openid-configuration',
+                   client_kwargs={'scope':'openid email profile'})
+    # if 'OIDC_CLIENT_SECRETS' in app.config.keys():
+    #     oauth.init_app(app)
+    #     oauth.register(name='mrmat',
+    #                    server_metadata_url='http://localhost:5001/.well-known/openid-configuration',
+    #                    client_kwargs={'scope':'openid email profile'})
+    # else:
+    #     app.logger.warning('Running without any authentication/authorisation')
 
     #
-    # Security Schemes
+    # Set Security Schemes in the generated OpenAPI descriptor
 
-    api.spec.components.security_scheme('openId', dict(
-                                            type='openIdConnect',
-                                            description='MrMat OIDC',
-                                            openIdConnectUrl='http://localhost:8080/auth/realms/master'
-                                                             '/.well-known/openid-configuration'
-                                        ))
+    # api.spec.components.security_scheme('openId',
+    #                                     {'type': 'openIdConnect',
+    #                                      'description': 'MrMat OIDC',
+    #                                      'openIdConnectUrl': 'http://localhost:8080/auth/realms/master/.well-known'
+    #                                                          '/openid-configuration'})
 
     #
     # Import and register our APIs here
@@ -163,8 +166,8 @@ def create_app(config_override=None, instance_path=None):
 
     @app.after_request
     def after_request(response: flask.Response) -> flask.Response:
-        log.info('[%s]', response.status_code)
-        response.headers.add('X-MrMat-Python-API-Flask-Version', __version__)
+        app.logger.info('[%s]', response.status_code)
+        response.headers.add(__app_version_header__, __version__)
         return response
 
     return app