Task runner

dev-requirements.in

@@ -2,6 +2,7 @@
 bandit
 black
 flake8
+invoke
 isort
 mypy
 pip-tools

dev-requirements.txt

@@ -46,6 +46,8 @@ idna==3.3
     # via requests
 iniconfig==1.1.1
     # via pytest
+invoke==1.6.0
+    # via -r .\dev-requirements.in
 isort==5.10.1
     # via -r .\dev-requirements.in
 mccabe==0.6.1

tasks.py

@@ -0,0 +1,46 @@
+from pathlib import Path
+
+from invoke import task
+
+from app.utils import get_asset
+
+PROJECT_DIR = Path()
+UI_FILES = tuple(get_asset('ui').glob("**/*.ui"))
+
+
+@task(
+    help={
+        'file': '`.ui` file to be converted to `.py`. If not supplied, all files will be converted. Available files: '
+        f'{", ".join(p.stem for p in UI_FILES)}'
+    }
+)
+def ui(c, file=None):
+    """
+    Convert QT `.ui` files into `.py`. `.ui` extension not required in the parameter.
+    """
+    if file:
+        file_stems = [file[:-3] if file.lower().endswith('.ui') else file]
+    else:
+        file_stems = [p.stem for p in UI_FILES]
+
+    for file_stem in file_stems:
+        ui_file_path = next(p for p in UI_FILES if p.stem == file_stem)
+        py_file_path = PROJECT_DIR / 'app/ui/forms' / f'{file_stem}_ui.py'
+
+        c.run(f'pyside6-uic {ui_file_path} -o {py_file_path}')
+
+
+@task
+def docs_serve(c):
+    """
+    Start documentation local server.
+    """
+    c.run('mkdocs serve')
+
+
+@task
+def docs_deploy(c):
+    """
+    Deploy documentation to GitHub.
+    """
+    c.run('mkdocs gh-deploy')