Merge pull request #82 from UCL-ARC/80-packaging

80 packaging

Author: shiyingwucl

.github/workflows/python-tests.yml

@@ -29,6 +29,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
+        pip install -e .
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |

.gitignore

@@ -6,4 +6,5 @@ tests/shortlist.pickle
 .pytest_cache/
 .ruff_cache/
 shortlister/*.ipynb
-ranked.pickle
+ranked.pickle
+dist/

pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "shortlister"
+description = "Tool to assist with shortlisting applications"
+version = "0.1.0"
+dependencies = ["PyMuPDF==1.24.13",
+"pytest==8.3.3",
+"readchar==4.2.0",
+"ruff==0.7.3",
+"tabulate==0.9.0",
+"universal-startfile==0.2",
+"pyreadline3==3.5.4",
+"pathvalidate==3.2.3",
+"openpyxl==3.1.5"]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+  "src/shortlister",
+]
+
+[project.scripts]
+shortlist = "shortlister.main:run"

shortlister/__init__.py src/shortlister/__init__.pyshortlister/__init__.py renamed to src/shortlister/__init__.py

@@ -33,9 +33,9 @@ def run_controller(wv_window: webview.Window=None):
     if wv_window is not None:
         wv_window.destroy()
 
-
-if cli_args.webview and webview is not None:
-    window = setup_webview()
-    webview.start(run_controller, args=[window])
-else:
-    run_controller(None)
+def run():
+    if cli_args.webview and webview is not None:
+        window = setup_webview()
+        webview.start(run_controller, args=[window])
+    else:
+        run_controller(None)