Small updates

.github/workflows/build.yml

@@ -72,8 +72,8 @@ jobs:
         export PYTHONUSERBASE=${HOME}/.local
         pip install --user wheel
         pip install --user -r requirements.txt
-        ${PYTHONUSERBASE}/bin/pylint ${GITHUB_WORKSPACE}/mrmat_python_api_flask
-        PYTHONPATH=${GITHUB_WORKSPACE} python -m pytest --cov=mrmat_python_api_flask
+        ${PYTHONUSERBASE}/bin/pylint ${GITHUB_WORKSPACE}/src/python/mrmat_python_api_flask
+        PYTHONPATH=${GITHUB_WORKSPACE}/src/python python -m pytest --cov=mrmat_python_api_flask
         PYTHONPATH=${GITHUB_WORKSPACE} python -m build --wheel -n
 
     - name: Upload test results

README.md

@@ -84,8 +84,8 @@ You have the choice of running this
 You can, of course, run this as a Flask app straight from the project directory:
 
 ```shell
-$ export FLASK_APP=mrmat_python_api_flask
-$ flask run
+$ cd src/python
+$ FLASK_APP=mrmat_python_api_flask flask run
  * Serving Flask app 'mrmat_python_api_flask' (lazy loading)
  * Environment: production
    WARNING: This is a development server. Do not use it in a production deployment.

requirements.txt

@@ -5,21 +5,21 @@
 
 # Build/Test requirements
 
-build~=0.7.0             # MIT
+build~=0.8.0             # MIT
 wheel~=0.37.1            # MIT
-pylint~=2.12.2           # GPL-2.0-or-later
-pytest~=7.0.1            # MIT
+pylint~=2.14.5           # GPL-2.0-or-later
+pytest~=7.1.2            # MIT
 pytest-cov~=3.0.0        # MIT
-pyjwt~=2.3.0             # MIT
-python-keycloak~=0.27.0  # MIT
+pyjwt~=2.4.0             # MIT
+python-keycloak~=2.1.1  # MIT
 
 # Runtime requirements
 
-rich~=11.2.0                    # MIT
-Flask~=2.0.3                    # BSD 3-Clause
+rich~=12.5.1                    # MIT
+Flask~=2.1.3                    # BSD 3-Clause
 Flask-SQLAlchemy~=2.5.1         # BSD 3-Clause
 Flask-Migrate~=3.1.0            # MIT
-flask-smorest~=0.37.0           # MIT
+flask-smorest~=0.38.1           # MIT
 Flask-Marshmallow~=0.14.0       # MIT
 marshmallow-sqlalchemy~=0.27.0  # MIT
 psycopg2-binary~=2.9.3          # LGPL with exceptions

setup.cfg

@@ -14,7 +14,10 @@ classifiers =
     Programming Language :: Python :: 3.9
 
 [options]
+package_dir =
+    =src/python
 packages = find:
+include_package_data = True
 install_requires =
     rich~=11.2.0
     Flask~=2.0.3
@@ -34,5 +37,10 @@ console_scripts =
     mrmat-python-api-flask-client = mrmat_python_api_flask.client:main
 
 [options.packages.find]
+where=src/python
 exclude =
     ci
+
+[options.package_data]
+mrmat_python_api_flask.migrations =
+    *

mrmat_python_api_flask/__init__.py → src/python/mrmat_python_api_flask/__init__.py

@@ -99,11 +99,11 @@ def format(self, record):
 try:
     __version__ = importlib.metadata.version('mrmat-python-api-flask')
 except importlib.metadata.PackageNotFoundError:
-    # You have not actually installed the wheel yet. We may be within CI so pick that version or fall back
-    __version__ = os.environ.get('MRMAT_VERSION', '0.0.0.dev0')
+    # You have not yet installed this as a package, likely because you're hacking on it in some IDE
+    __version__ = '0.0.0.dev0'
 
 #
-# Initialise supporting services
+# Initialize supporting services
 
 db = SQLAlchemy()
 ma = Marshmallow()

tests/conftest.py

@@ -90,7 +90,12 @@ def app(self):
             'SECRET_KEY': secrets.token_hex(16)
         })
         with self._app.app_context():
-            upgrade(directory=os.path.join(os.path.dirname(__file__), '..', 'migrations'))
+            upgrade(directory=os.path.join(os.path.dirname(__file__),
+                                           '..',
+                                           'src',
+                                           'python',
+                                           'mrmat_python_api_flask',
+                                           'migrations'))
             db.create_all()
         yield self._app