Merge remote-tracking branch 'origin/feature/pep517' into feature/pep517

# Conflicts:
#	README.md
#	mrmat_python_api_flask/__init__.py
#	requirements.txt

Author: MrMatAP

.flake8

@@ -44,7 +44,7 @@ jobs:
     - name: Calculate Build Context
       run: |
         MRMAT_VERSION="${MAJOR}.${MINOR}.${GITHUB_RUN_NUMBER}"
-        if [ "$GITHUB_EVENT_NAME" == 'pull_request_target' ]; then
+        if [ "$GITHUB_EVENT_NAME" == 'pull_request_target' && GITHUB_BASE_REF == 'main']; then
           MRMAT_IS_RELEASE=true
           echo "::warning ::Building release ${MRMAT_VERSION}"
           echo "MRMAT_IS_RELEASE=true" >> $GITHUB_ENV
@@ -65,19 +65,12 @@ jobs:
         path: ~/.local
         key: ${{ runner.os }}
 
-    - name: Install dependencies
+    - name: Build
       run: |
-        python -m pip install --upgrade pip
-        pip install --user wheel
         pip install --user -r requirements.txt
-        pip install --user -r test-requirements.txt
-
-    - name: Test
-      run: |
-        flake8 --statistics
-        pylint mrmat_python_api_flask
-        python ./setup.py install
-        python -m pytest
+        pylint ${GITHUB_WORKSPACE}/mrmat_python_api_flask
+        PYTHONPATH=${GITHUB_WORKSPACE} python -m pytest --cov=mrmat_python_api_flask
+        PYTHONPATH=${GITHUB_WORKSPACE} python -m build --wheel -n
 
     - name: Upload test results
       uses: actions/upload-artifact@v2
@@ -90,7 +83,7 @@ jobs:
 
     - name: Conditional Release
       uses: marvinpinto/action-automatic-releases@latest
-      if: github.event.pull_request.merged == true
+      if: (github.event.pull_request.merged == true && github.base_ref == 'main')
       with:
         repo_token: "${{ secrets.GITHUB_TOKEN }}"
         automatic_release_tag: "${{ env.MRMAT_VERSION }}"

.github/workflows/build.yml

@@ -18,9 +18,9 @@ This variant of a Python Flask API is code-first and using native Flask
 
 ## How to build this
 
-In bash:
+Building a wheel boils down to this (in bash or Powershell):
 
-```shell
+```bash
 $ pip install -r requirements.txt  # Manually install dependencies (see note in requirements.txt!)
 $ export PYTHONPATH=`pwd`                # In order to find the build-time ci module
 $ export MRMAT_VERSION=1.0.27            # Optional: To influence the version. Normally calculated and set by CI
@@ -29,15 +29,28 @@ $ ls dist/
 mrmat_python_api_flask-1.0.27.dev0-py3-none-any.whl
 ```
 
-In PowerShell:
-
 ```powershell
 PS> pip install -r build-requirements.txt     # Manually install dependencies (see note in requirements.txt!)
 PS> $Env:PYTHONPATH=(pwd)                     # In order to find the build-time ci module
 PS> $Env:MRMAT_VERSION = "1.0.27"             # Optional: To influence the version. Normally calculated and set by CI
 PS> python -m build
 ```
 
+This project uses the [PEP517 build mechanism](https://www.python.org/dev/peps/pep-0517/), but with a twist so CI is in
+control over the generation of the micro version number. In our case, CI is GitHub Actions, which has the top-level
+environment variables `MAJOR` and `MINOR`. These two are intended to be infrequently updated manually if and when
+it is needed. The micro version is automatically set by the `GITHUB_RUN_NUMBER` which increases for every build
+we do. The `MRMAT_VERSION` environment variable is a concatenation of these three. If the build is via a PR onto
+main then this is the release version. Otherwise `.dev0` is appended to the version.
+
+If you are building locally, then your version will **always** be `0.0.0.dev0` (unless you explicitly set the
+`MRMAT_VERSION` environment variable to something different).
+
+It is necessary for setup.cfg to figure out whether and what `MRMAT_VERSION` is set to. Since this is no longer
+an executable in PEP517, we tell it to use the `ci` module for doing so. The `ci` module simply picks up `MRMAT_VERSION`
+from the environment, no more and the module is explicitly ignored from packaging. However, you must ensure that
+the top-level `ci` module is on the Python path as you build (hence the setup above).
+
 ## How to run this
 
 You have the choice of running this 

.idea/dataSources.xml

@@ -25,48 +25,31 @@
 
 import sys
 import os
+import logging
 import importlib.metadata
-from logging.config import dictConfig
+
+from rich.console import Console
+from rich.logging import RichHandler
 
 from flask import Flask
 from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
 from flask_marshmallow import Marshmallow
 from flask_oidc import OpenIDConnect
 
-try:
-    __version__ = importlib.metadata.version('mrmat-python-api-flask')
-except importlib.metadata.PackageNotFoundError:
-    # You have not explicitly installed the package just yet
-    __version__ = 'UNKNOWN'
+logging.basicConfig(level='INFO',
+                    handlers=[RichHandler(rich_tracebacks=True,
+                                          show_path=False,
+                                          omit_repeated_times=False)])
+log = logging.getLogger(__name__)
+console = Console()
 
+__version__ = importlib.metadata.version('mrmat-python-api-flask')
 db = SQLAlchemy()
 ma = Marshmallow()
 migrate = Migrate()
 oidc = OpenIDConnect()
 
-dictConfig({
-    'version': 1,
-    'formatters': {'default': {
-        'format': '[%(asctime)s] %(levelname)s: %(message)s',
-    }},
-    'handlers': {
-        'wsgi': {
-            'class': 'logging.StreamHandler',
-            'stream': 'ext://flask.logging.wsgi_errors_stream',
-            'formatter': 'default'
-        }
-    },
-    'root': {
-        'level': 'INFO',
-        'handlers': ['wsgi']
-    },
-    'mrmat_python_api_flask': {
-        'level': 'INFO',
-        'handlers': ['wsgi']
-    }
-})
-
 
 def create_app(config_override=None, instance_path=None):
     """Factory method to create a Flask app.
@@ -87,7 +70,8 @@ def create_app(config_override=None, instance_path=None):
     #
     # Set configuration defaults. If a config file is present then load it. If we have overrides, apply them
 
-    app.config.setdefault('SECRET_KEY', os.urandom(16))
+    # TODO
+    #app.config.setdefault('SECRET_KEY', 'JFg4K1l5vVmusHmI0cNAFg')
     app.config.setdefault('SQLALCHEMY_DATABASE_URI',
                           'sqlite+pysqlite:///' + os.path.join(app.instance_path, 'mrmat-python-api-flask.sqlite'))
     app.config.setdefault('SQLALCHEMY_TRACK_MODIFICATIONS', False)

.idea/markdown.xml

@@ -38,11 +38,11 @@
 
 def _extract_identity() -> Tuple:
     return g.oidc_token_info['client_id'], \
-           g.oidc_token_info['preferred_username']
+           g.oidc_token_info['username']
 
 
 @bp.route('/', methods=['GET'])
-@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
+@oidc.accept_token(require_token=True, scopes_required=['mpaf-read'])
 def get_all():
     identity = _extract_identity()
     logger.info(f'Called by {identity[1]} ({identity[0]}')
@@ -51,7 +51,7 @@ def get_all():
 
 
 @bp.route('/<i>', methods=['GET'])
-@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
+@oidc.accept_token(require_token=True, scopes_required=['mpaf-read'])
 def get_one(i: int):
     identity = _extract_identity()
     logger.info(f'Called by {identity[1]} ({identity[0]}')
@@ -62,7 +62,7 @@ def get_one(i: int):
 
 
 @bp.route('/', methods=['POST'])
-@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+@oidc.accept_token(require_token=True, scopes_required=['mpaf-write'])
 def create():
     (client_id, name) = _extract_identity()
     logger.info(f'Called by {name} ({client_id}')
@@ -99,7 +99,7 @@ def create():
 
 
 @bp.route('/<i>', methods=['PUT'])
-@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+@oidc.accept_token(require_token=True, scopes_required=['mpaf-write'])
 def modify(i: int):
     (client_id, name) = _extract_identity()
     logger.info(f'Called by {name} ({client_id}')
@@ -118,7 +118,7 @@ def modify(i: int):
 
 
 @bp.route('/<i>', methods=['DELETE'])
-@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+@oidc.accept_token(require_token=True, scopes_required=['mpaf-write'])
 def remove(i: int):
     (client_id, name) = _extract_identity()
     logger.info(f'Called by {name} ({client_id}')

.idea/runConfigurations/tests.xml

@@ -29,11 +29,9 @@
 from time import sleep
 from argparse import ArgumentParser, Namespace
 from typing import List, Optional, Dict
-import cli_ui
-from halo import Halo
 import requests
 
-from mrmat_python_api_flask import __version__
+from mrmat_python_api_flask import __version__, log
 
 
 class ClientException(Exception):
@@ -76,7 +74,6 @@ def oidc_device_auth(config: Dict, discovery: Dict) -> Dict:
     return data
 
 
-@Halo(text='Checking authentication')
 def oidc_check_auth(config: Dict, discovery: Dict, device_auth: Dict):
     wait = 5
     stop = False
@@ -159,7 +156,6 @@ def main(argv=None) -> int:
     args = parse_args(argv if argv is not None else sys.argv[1:])
     if args is None:
         return 0
-    cli_ui.setup(verbose=args.debug, quiet=args.quiet, timestamp=False)
 
     #
     # Read from the config file by default, but allow overrides via the CLI
@@ -191,23 +187,23 @@ def main(argv=None) -> int:
             raise ClientException(msg='No expires_in in device_auth')
 
         # Adding the user code to the URL is convenient, but not as secure as it could be
-        cli_ui.info(f'Please visit {device_auth["verification_uri"]} within {device_auth["expires_in"]} seconds and '
+        log.info(f'Please visit {device_auth["verification_uri"]} within {device_auth["expires_in"]} seconds and '
                     f'enter code {device_auth["user_code"]}. Or just visit {device_auth["verification_uri_complete"]}')
 
         auth = oidc_check_auth(config, discovery, device_auth)
-        cli_ui.info('Authenticated')
+        log.info('Authenticated')
 
         #
         # We're using requests directly here because requests_oauthlib doesn't support device code flow directly
 
         resp = requests.get('http://127.0.0.1:5000/api/greeting/v3/',
                             headers={'Authorization': f'Bearer {auth["id_token"]}'})
-        cli_ui.info(f'Status Code: {resp.status_code}')
-        cli_ui.info(resp.content)
+        log.info(f'Status Code: {resp.status_code}')
+        log.info(resp.content)
 
         return 0
     except ClientException as ce:
-        cli_ui.error(ce.msg)
+        log.error(ce.msg)
         return ce.exit_code
 
 

README.md

@@ -4,7 +4,7 @@
 
 [pytest]
 testpaths = tests
-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
 junit_family = xunit2
 log_cli = 1
 log_cli_level = INFO