refactor a bit, linting, introduce setuptools-scm, fix a bunch of package meta stuff

Author: tykling

.github/workflows/pypi.yml

@@ -0,0 +1,31 @@
+---
+name: "Publish PyPi package when a new tag is pushed"
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    tags:
+      - 'v*'
+
+# https://docs.pypi.org/trusted-publishers/using-a-publisher/
+jobs:
+  pypi-publish:
+    name: "upload release to PyPI"
+    runs-on: "ubuntu-latest"
+    environment: "pypi-publish"
+    permissions:
+      id-token: "write"
+    steps:
+      # https://github.com/pypa/sampleproject/blob/main/.github/workflows/release.yml
+      - name: "Checkout"
+        uses: "actions/checkout@v3"
+      - name: "Set up Python"
+        uses: "actions/setup-python@v4"
+        with:
+          python-version: '3.11'
+      - name: "Install build dependencies"
+        run: "python -m pip install -U setuptools wheel build"
+      - name: "Build"
+        run: "python -m build ."
+      - name: "Publish package distributions to PyPI"
+        uses: "pypa/gh-action-pypi-publish@release/v1"
+...

.gitignore

@@ -1,3 +1,6 @@
+# vim
+*.swp
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+---
+default_language_version:
+  python: "python3"
+repos:
+  - repo: "https://github.com/astral-sh/ruff-pre-commit"
+    rev: "v0.6.9"
+    hooks:
+      - id: "ruff"
+        args: ["--fix"]
+      - id: "ruff-format"
+  - repo: "https://github.com/pre-commit/mirrors-mypy"
+    rev: 'v1.11.2'
+    hooks:
+      - id: "mypy"
+        additional_dependencies:
+          - "typer-slim"
+          - "bornhack-media-archive-client"
+...

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -13,13 +13,13 @@ classifiers = [
 ]
 dependencies = [
     "typer-slim==0.12.5",
-    "bma-client",
+    "bornhack-media-archive-client",
 ]
 description = "BornHack Media Archive CLI Tool"
 name = "bma-cli"
-version = "0.1"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
+dynamic = ["version"]
 
 [project.scripts]
 "bma" = "bma_cli:app"
@@ -35,6 +35,8 @@ homepage = "https://github.com/bornhack/bma-cli-python"
 [tool.setuptools]
 package-dir = {"" = "src"}
 
+[tool.setuptools_scm]
+
 [tool.setuptools.packages.find]
 where = ["src"]
 

src/bma_cli.py

@@ -5,7 +5,7 @@
 import sys
 import time
 import uuid
-from io import BytesIO
+from importlib.metadata import version as get_version
 from pathlib import Path
 from typing import TypedDict
 
@@ -56,6 +56,13 @@ class ImageExifExtractionJob(BaseJob):
     """Represent an ImageExifExtractionJob."""
 
 
+@app.command()
+def version() -> None:
+    """Return the version of bma-cli and bma-client."""
+    click.echo(f"bma-cli version {get_version('bma-cli')}")
+    click.echo(f"bma-client version {get_version('bma-client')}")
+
+
 @app.command()
 def fileinfo(file_uuid: uuid.UUID) -> None:
     """Get info for a file."""
@@ -66,12 +73,11 @@ def fileinfo(file_uuid: uuid.UUID) -> None:
 
 @app.command()
 def jobs() -> None:
-    """Get info on assigned jobs."""
+    """Get info on unfinished jobs."""
     client, config = init()
-    jobs = client.get_jobs(job_filter=f"?limit=0&finished=false&client_uuid={client.uuid}")
+    jobs = client.get_jobs(job_filter="?limit=0&finished=false")
     click.echo(json.dumps(jobs))
-    click.echo(f"Total {len(jobs)} unfinished jobs assigned to this client.")
-
+    click.echo(f"Total {len(jobs)} unfinished jobs.", err=True)
 
 
 @app.command()
@@ -88,22 +94,24 @@ def grind() -> None:
     """Get jobs from the server and handle them."""
     client, config = init()
 
-    # get any unfinished jobs already assigned to this client
-    jobs = client.get_jobs(job_filter=f"?limit=0&finished=false&client_uuid={client.uuid}")
-    if not jobs:
-        # no unfinished jobs assigned to this client, ask for new assignment
-        jobs = client.get_job_assignment()
-
-    if not jobs:
-        click.echo("Nothing to do.")
-        return
-
-    # loop over jobs and handle each
-    for job in jobs:
-        # make sure we have the original file locally
-        fileinfo = client.download(file_uuid=job["basefile_uuid"])
-        path = Path(config["path"], fileinfo["filename"])
-        handle_job(f=path, job=job, client=client, config=config)
+    while True:
+        # get any unfinished jobs already assigned to this client
+        jobs = client.get_jobs(job_filter=f"?limit=0&finished=false&client_uuid={client.uuid}")
+        if not jobs:
+            # no unfinished jobs assigned to this client, ask for new assignment
+            jobs = client.get_job_assignment()
+
+        if not jobs:
+            click.echo("Nothing left to do.")
+            return
+
+        # loop over jobs and handle each
+        click.echo(f"Processing {len(jobs)} jobs for file {jobs[0]['basefile_uuid']} ...")
+        for job in jobs:
+            # make sure we have the original file locally
+            fileinfo = client.download(file_uuid=job["basefile_uuid"])
+            path = Path(config["path"], fileinfo["filename"])
+            handle_job(f=path, job=job, client=client, config=config)
     click.echo("Done!")
 
 
@@ -121,7 +129,7 @@ def upload(files: list[str]) -> None:
         if metadata["jobs_unfinished"] == 0:
             continue
 
-        # it seems there is work to do! ask for assignment
+        # it seems there is work to do for the newly uploaded file!
         jobs = client.get_job_assignment(file_uuid=metadata["uuid"])
         if not jobs:
             click.echo("No unassigned unfinished jobs found for this file.")
@@ -157,29 +165,7 @@ def handle_job(f: Path, job: ImageConversionJob | ImageExifExtractionJob, client
     click.echo(f"Handling job {job['job_type']} {job['job_uuid']} ...")
     start = time.time()
     result = client.handle_job(job=job, orig=f)
-    logger.debug(f"Getting result took {time.time() - start} seconds")
-    if not result:
-        click.echo(f"No result returned for job {job['job_type']} {job['uuid']} - skipping ...")
-        return
-
-    # got job result, do whatever is needed depending on job_type
-    if job["job_type"] == "ImageConversionJob":
-        image, exif = result
-        filename = job["job_uuid"] + "." + job["filetype"].lower()
-        logger.debug(f"Encoding result as {job['filetype']} ...")
-        start = time.time()
-        with BytesIO() as buf:
-            image.save(buf, format=job["filetype"], exif=exif, lossless=False, quality=90)
-            logger.debug(f"Encoding result took {time.time() - start} seconds")
-            client.upload_job_result(job_uuid=job["job_uuid"], buf=buf, filename=filename)
-    elif job["job_type"] == "ImageExifExtractionJob":
-        logger.debug(f"Got exif data {result}")
-        with BytesIO() as buf:
-            buf.write(json.dumps(result).encode())
-            client.upload_job_result(job_uuid=job["job_uuid"], buf=buf, filename="exif.json")
-    else:
-        logger.error("Unsupported job type")
-        raise typer.Exit(1)
+    logger.debug(f"Getting result took {time.time() - start} seconds: {result}")
 
 
 def load_config() -> dict[str, str]: