Merge pull request #267 from sartography/feature/remove-sphinx-from-pyproject

Feature/remove sphinx from pyproject

.github/workflows/backend_tests.yml

@@ -75,7 +75,7 @@ jobs:
               database: "sqlite",
             }
           - { python: "3.11", os: "ubuntu-latest", session: "xdoctest" }
-          - { python: "3.11", os: "ubuntu-latest", session: "docs-build" }
+          # - { python: "3.11", os: "ubuntu-latest", session: "docs-build" }
 
     env:
       FLASK_SESSION_SECRET_KEY: super_secret_key
@@ -119,20 +119,23 @@ jobs:
           pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
           nox --version
 
-      - name: Checkout Samples
+      # when we get an imcompatible sqlite migration again and need to combine all migrations into one for the benefit of sqlite
-        if: matrix.database == 'sqlite'
+      # see if we can get the sqlite-specific block in the noxfile.py to work instead of this block in the github workflow,
-        uses: actions/checkout@v3
+      # which annoyingly runs python setup outside of the nox environment (which seems to be flakier on poetry install).
-        with:
+      # - name: Checkout Samples
-          repository: sartography/sample-process-models
+      #   if: matrix.database == 'sqlite'
-          path: sample-process-models
+      #   uses: actions/checkout@v3
-      - name: Poetry Install
+      #   with:
-        if: matrix.database == 'sqlite'
+      #     repository: sartography/sample-process-models
-        run: poetry install
+      #     path: sample-process-models
-      - name: Setup sqlite
+      # - name: Poetry Install
-        if: matrix.database == 'sqlite'
+      #   if: matrix.database == 'sqlite'
-        env:
+      #   run: poetry install
-          SPIFFWORKFLOW_BACKEND_BPMN_SPEC_ABSOLUTE_DIR: "${GITHUB_WORKSPACE}/sample-process-models"
+      # - name: Setup sqlite
-        run: ./bin/recreate_db clean rmall
+      #   if: matrix.database == 'sqlite'
+      #   env:
+      #     SPIFFWORKFLOW_BACKEND_BPMN_SPEC_ABSOLUTE_DIR: "${GITHUB_WORKSPACE}/sample-process-models"
+      #   run: ./bin/recreate_db clean rmall
 
       - name: Setup Mysql
         uses: mirromutth/mysql-action@v1.1
@@ -162,13 +165,13 @@ jobs:
           name: coverage-data
           path: "spiffworkflow-backend/.coverage.*"
 
-      - name: Upload documentation
+      # - name: Upload documentation
-        if: matrix.session == 'docs-build'
+      #   if: matrix.session == 'docs-build'
-        uses: actions/upload-artifact@v3
+      #   uses: actions/upload-artifact@v3
-        with:
+      #   with:
-          name: docs
+      #     name: docs
-          path: docs/_build
+      #     path: docs/_build
-
+      #
       - name: Upload logs
         if: failure() && matrix.session == 'tests'
         uses: "actions/upload-artifact@v3"

spiffworkflow-backend/noxfile.py

@@ -41,6 +41,18 @@ def setup_database(session: Session) -> None:
     session.env[flask_env_key] = "e7711a3ba96c46c68e084a86952de16f"
     session.env["FLASK_APP"] = "src/spiffworkflow_backend"
     session.env["SPIFFWORKFLOW_BACKEND_ENV"] = "unit_testing"
+
+    if os.environ.get("SPIFFWORKFLOW_BACKEND_DATABASE_TYPE") == "sqlite":
+        # maybe replace this sqlite-specific block with ./bin/recreate_db clean rmall
+        # (if we can make it work, since it uses poetry),
+        # which would also remove the migrations folder and re-create things as a single migration
+        if os.path.exists("migrations"):
+            import shutil
+
+            shutil.rmtree("migrations")
+        for task in ["init", "migrate"]:
+            session.run("flask", "db", task)
+
     session.run("flask", "db", "upgrade")
 
 

spiffworkflow-backend/pyproject.toml

@@ -31,7 +31,7 @@ SpiffWorkflow = {git = "https://github.com/sartography/SpiffWorkflow", rev = "ma
 # SpiffWorkflow = {git = "https://github.com/sartography/SpiffWorkflow", rev = "6cad2981712bb61eca23af1adfafce02d3277cb9"}
 # SpiffWorkflow = {develop = true, path = "../../spiffworkflow/" }
 sentry-sdk = "^1.10"
-sphinx-autoapi = "^2.0"
+# sphinx-autoapi = "^2.0"
 mysql-connector-python = "*"
 pytest-flask = "^1.2.0"
 pytest-flask-sqlalchemy = "^1.1.0"
@@ -93,8 +93,8 @@ safety = "^2.3.1"
 mypy = ">=0.961"
 typeguard = "^3"
 xdoctest = {extras = ["colors"], version = "^1.0.1"}
-sphinx = "^5.0.2"
+# sphinx = "^5.0.2"
-sphinx-autobuild = ">=2021.3.14"
+# sphinx-autobuild = ">=2021.3.14"
 pre-commit = "^2.20.0"
 flake8 = "^4.0.1"
 black = ">=21.10b0"
@@ -111,10 +111,10 @@ pep8-naming = "^0.13.2"
 darglint = "^1.8.1"
 reorder-python-imports = "^3.9.0"
 pre-commit-hooks = "^4.0.1"
-sphinx-click = "^4.3.0"
+# sphinx-click = "^4.3.0"
 Pygments = "^2.10.0"
 pyupgrade = "^3.1.0"
-furo = ">=2021.11.12"
+# furo = ">=2021.11.12"
 
 [tool.poetry.scripts]
 spiffworkflow-backend = "spiffworkflow_backend.__main__:main"