pearmut 0.0.6__tar.gz → 0.1.0__tar.gz

{pearmut-0.0.6 → pearmut-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pearmut
-Version: 0.0.6
+Version: 0.1.0
 Summary: A tool for evaluation of model outputs, primarily MT.
 Author-email: Vilém Zouhar <vilem.zouhar@gmail.com>
 License: apache-2.0
@@ -13,6 +13,7 @@ License-File: LICENSE
 Requires-Dist: fastapi>=0.110.0
 Requires-Dist: uvicorn>=0.29.0
 Requires-Dist: wonderwords>=3.0.0
+Requires-Dist: psutil>=7.1.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pynpm>=0.3.0; extra == "dev"
@@ -32,9 +33,11 @@ Supports multimodality (text, video, audio, images) and a variety of annotation
 &nbsp;
 [![build status](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml/badge.svg)](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml)
 
-<img width="1334" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/dde04b98-c724-4226-b926-011a89e9ce31" />
+<img width="1000" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/f14c91a5-44d7-4248-ada9-387e95ca59d0" />
 
 ## Quick start
+
+You do not need to clone this repository. Simply install with pip and run locally:
 ```bash
 # install the package
 pip install pearmut
@@ -55,7 +58,7 @@ First, install the package
 pip install pearmut
 ```
 
-A campaign is described in a single JSON file (see [examples/](examples/)!).
+A campaign is described in a single JSON file (see [examples/](examples/)).
 One of the simplest ones, where each user has a pre-defined list of tasks (`task-based`), is:
 ```python
 {
@@ -65,24 +68,25 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
     "protocol_score": true,                 # we want scores [0...100] for each segment
     "protocol_error_spans": true,           # we want error spans
     "protocol_error_categories": false,     # we do not want error span categories
-    "status_message": "Evaluate translation from en to cs_CZ",  # message to show to users
-    "url": "http://localhost:8001"          # where the server will be accessible
+    "instructions": "Evaluate translation from en to cs_CZ",  # message to show to users
   },
   "campaign_id": "wmt25_#_en-cs_CZ",
   "data": [
     # data for first task/user
     [
-      {
+      [
         # each evaluation item is a document
-        "src": [
-          "This will be the year that Guinness loses its cool. Cheers to that!",
-          "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
-        ],
-        "tgt": [
-          "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!",
-          "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ...",
-        ]
-      },
+        {
+          "src": "This will be the year that Guinness loses its cool. Cheers to that!",
+          "tgt": "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ..."
+        },
+        {
+          "src": "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
+          "tgt": "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!"
+        }
+        ...
+      ],
+      # more document
       ...
     ],
     # data for second task/user
@@ -96,12 +100,19 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
 In general, the task item can be anything and is handled by the specific protocol template.
 For the standard ones (ESA, DA, MQM), we expect each item to be a dictionary (corresponding to a single document unit) that looks as follows:
 ```python
-{   # single document definition
-    "src": ["A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", "toto je pokračování stejného dokumentu"],       # mandatory for ESA/MQM/DA
-    "tgt": ["And suddenly all the water became full of other people and other people.", "this is a continuation of the same document"], # mandatory for ESA/MQM/DA
+# single document definition
+[
+  {
+    "src": "A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", # mandatory for ESA/MQM/DA
+    "tgt": "And suddenly all the water became full of other people and other people." # mandatory for ESA/MQM/DA
+  },
+  {
+    "src": "toto je pokračování stejného dokumentu",
+    "tgt": "this is a continuation of the same document",
     ...  # all other keys that will be stored, useful for your analysis
-},
-... # definition of another item
+  }
+],
+... # definition of another item (document)
 ```
 
 We also support a super simple allocation of annotations (`task-single`, not yet ⚠️), where you simply pass a list of all examples to be evaluated and they are processed in parallel by all annotators:
@@ -146,6 +157,7 @@ pearmut run
 ## Campaign management
 
 When adding new campaigns or launching pearmut, a management link is shown that gives an overview of annotator progress but also an easy access to the annotation links or resetting the task progress (no data will be lost).
+This is also the place where you can download all progress and collected annotations (these files exist also locally but this might be more convenient).
 
 <img width="800" alt="Management dashboard" src="https://github.com/user-attachments/assets/057899d7-2291-46c7-876f-407c4050a9cb" />
 
@@ -165,9 +177,12 @@ Tip: make sure the elements are already appropriately styled.
 
 ## Development
 
-For the server and frontend locally run:
-
+Pearmut works by running a server that responds to requests from the frontend.
+These requests are not template-based but rather carry only data (which gives flexibility in designing new protocols and interfaces).
+By default, the frontend is served from `static/` which is pre-built when you `pip install pearmut`.
+To make changes locally, clone the repository and run the following, which will recompile the frontend on changes (server changes need server restart):
 ```bash
+cd pearmut
 # watch the frontend for changes (in a separate terminal)
 npm install web/ --prefix web/
 npm run watch --prefix web/
@@ -185,12 +200,15 @@ pearmut run
 Optionally, you can specify `--server` in `pearmut add` and `pearmut run` to show correct URL prefixes.
 The `pearmut run` also accepts `--port` (default 8001). 
 
+If you wish to create a new protocol (referenceable from `info->template`), simply create a new HTML and TS file in `web/src` and add a rule to `webpack.config.js` so that your template gets built.
+A template can call the server for data etc (see [web/src/pointwise.ts](web/src/pointwise.ts) as an exmple).
+
 ## Citation
 
 If you use this work in your paper, please cite as:
 ```bibtex
 @misc{zouhar2025pearmut,
-    author={Vilém Zouhar and others},
+    author={Vilém Zouhar},
     title={Pearmut🍐 Platform for Evaluation and Reviewing of Multilingual Tasks},
     url={https://github.com/zouharvi/pearmut/},
     year={2025},

{pearmut-0.0.6 → pearmut-0.1.0}/README.md

@@ -12,9 +12,11 @@ Supports multimodality (text, video, audio, images) and a variety of annotation
  
 [![build status](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml/badge.svg)](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml)
 
-<img width="1334" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/dde04b98-c724-4226-b926-011a89e9ce31" />
+<img width="1000" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/f14c91a5-44d7-4248-ada9-387e95ca59d0" />
 
 ## Quick start
+
+You do not need to clone this repository. Simply install with pip and run locally:
 ```bash
 # install the package
 pip install pearmut
@@ -35,7 +37,7 @@ First, install the package
 pip install pearmut
 ```
 
-A campaign is described in a single JSON file (see [examples/](examples/)!).
+A campaign is described in a single JSON file (see [examples/](examples/)).
 One of the simplest ones, where each user has a pre-defined list of tasks (`task-based`), is:
 ```python
 {
@@ -45,24 +47,25 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
     "protocol_score": true,                 # we want scores [0...100] for each segment
     "protocol_error_spans": true,           # we want error spans
     "protocol_error_categories": false,     # we do not want error span categories
-    "status_message": "Evaluate translation from en to cs_CZ",  # message to show to users
-    "url": "http://localhost:8001"          # where the server will be accessible
+    "instructions": "Evaluate translation from en to cs_CZ",  # message to show to users
   },
   "campaign_id": "wmt25_#_en-cs_CZ",
   "data": [
     # data for first task/user
     [
-      {
+      [
         # each evaluation item is a document
-        "src": [
-          "This will be the year that Guinness loses its cool. Cheers to that!",
-          "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
-        ],
-        "tgt": [
-          "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!",
-          "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ...",
-        ]
-      },
+        {
+          "src": "This will be the year that Guinness loses its cool. Cheers to that!",
+          "tgt": "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ..."
+        },
+        {
+          "src": "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
+          "tgt": "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!"
+        }
+        ...
+      ],
+      # more document
       ...
     ],
     # data for second task/user
@@ -76,12 +79,19 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
 In general, the task item can be anything and is handled by the specific protocol template.
 For the standard ones (ESA, DA, MQM), we expect each item to be a dictionary (corresponding to a single document unit) that looks as follows:
 ```python
-{   # single document definition
-    "src": ["A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", "toto je pokračování stejného dokumentu"],       # mandatory for ESA/MQM/DA
-    "tgt": ["And suddenly all the water became full of other people and other people.", "this is a continuation of the same document"], # mandatory for ESA/MQM/DA
+# single document definition
+[
+  {
+    "src": "A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", # mandatory for ESA/MQM/DA
+    "tgt": "And suddenly all the water became full of other people and other people." # mandatory for ESA/MQM/DA
+  },
+  {
+    "src": "toto je pokračování stejného dokumentu",
+    "tgt": "this is a continuation of the same document",
     ...  # all other keys that will be stored, useful for your analysis
-},
-... # definition of another item
+  }
+],
+... # definition of another item (document)
 ```
 
 We also support a super simple allocation of annotations (`task-single`, not yet ⚠️), where you simply pass a list of all examples to be evaluated and they are processed in parallel by all annotators:
@@ -126,6 +136,7 @@ pearmut run
 ## Campaign management
 
 When adding new campaigns or launching pearmut, a management link is shown that gives an overview of annotator progress but also an easy access to the annotation links or resetting the task progress (no data will be lost).
+This is also the place where you can download all progress and collected annotations (these files exist also locally but this might be more convenient).
 
 <img width="800" alt="Management dashboard" src="https://github.com/user-attachments/assets/057899d7-2291-46c7-876f-407c4050a9cb" />
 
@@ -145,9 +156,12 @@ Tip: make sure the elements are already appropriately styled.
 
 ## Development
 
-For the server and frontend locally run:
-
+Pearmut works by running a server that responds to requests from the frontend.
+These requests are not template-based but rather carry only data (which gives flexibility in designing new protocols and interfaces).
+By default, the frontend is served from `static/` which is pre-built when you `pip install pearmut`.
+To make changes locally, clone the repository and run the following, which will recompile the frontend on changes (server changes need server restart):
 ```bash
+cd pearmut
 # watch the frontend for changes (in a separate terminal)
 npm install web/ --prefix web/
 npm run watch --prefix web/
@@ -165,12 +179,15 @@ pearmut run
 Optionally, you can specify `--server` in `pearmut add` and `pearmut run` to show correct URL prefixes.
 The `pearmut run` also accepts `--port` (default 8001). 
 
+If you wish to create a new protocol (referenceable from `info->template`), simply create a new HTML and TS file in `web/src` and add a rule to `webpack.config.js` so that your template gets built.
+A template can call the server for data etc (see [web/src/pointwise.ts](web/src/pointwise.ts) as an exmple).
+
 ## Citation
 
 If you use this work in your paper, please cite as:
 ```bibtex
 @misc{zouhar2025pearmut,
-    author={Vilém Zouhar and others},
+    author={Vilém Zouhar},
     title={Pearmut🍐 Platform for Evaluation and Reviewing of Multilingual Tasks},
     url={https://github.com/zouharvi/pearmut/},
     year={2025},

{pearmut-0.0.6 → pearmut-0.1.0}/pearmut.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pearmut
-Version: 0.0.6
+Version: 0.1.0
 Summary: A tool for evaluation of model outputs, primarily MT.
 Author-email: Vilém Zouhar <vilem.zouhar@gmail.com>
 License: apache-2.0
@@ -13,6 +13,7 @@ License-File: LICENSE
 Requires-Dist: fastapi>=0.110.0
 Requires-Dist: uvicorn>=0.29.0
 Requires-Dist: wonderwords>=3.0.0
+Requires-Dist: psutil>=7.1.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pynpm>=0.3.0; extra == "dev"
@@ -32,9 +33,11 @@ Supports multimodality (text, video, audio, images) and a variety of annotation
 &nbsp;
 [![build status](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml/badge.svg)](https://github.com/zouharvi/pearmut/actions/workflows/ci.yml)
 
-<img width="1334" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/dde04b98-c724-4226-b926-011a89e9ce31" />
+<img width="1000" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/f14c91a5-44d7-4248-ada9-387e95ca59d0" />
 
 ## Quick start
+
+You do not need to clone this repository. Simply install with pip and run locally:
 ```bash
 # install the package
 pip install pearmut
@@ -55,7 +58,7 @@ First, install the package
 pip install pearmut
 ```
 
-A campaign is described in a single JSON file (see [examples/](examples/)!).
+A campaign is described in a single JSON file (see [examples/](examples/)).
 One of the simplest ones, where each user has a pre-defined list of tasks (`task-based`), is:
 ```python
 {
@@ -65,24 +68,25 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
     "protocol_score": true,                 # we want scores [0...100] for each segment
     "protocol_error_spans": true,           # we want error spans
     "protocol_error_categories": false,     # we do not want error span categories
-    "status_message": "Evaluate translation from en to cs_CZ",  # message to show to users
-    "url": "http://localhost:8001"          # where the server will be accessible
+    "instructions": "Evaluate translation from en to cs_CZ",  # message to show to users
   },
   "campaign_id": "wmt25_#_en-cs_CZ",
   "data": [
     # data for first task/user
     [
-      {
+      [
         # each evaluation item is a document
-        "src": [
-          "This will be the year that Guinness loses its cool. Cheers to that!",
-          "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
-        ],
-        "tgt": [
-          "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!",
-          "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ...",
-        ]
-      },
+        {
+          "src": "This will be the year that Guinness loses its cool. Cheers to that!",
+          "tgt": "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ..."
+        },
+        {
+          "src": "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
+          "tgt": "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!"
+        }
+        ...
+      ],
+      # more document
       ...
     ],
     # data for second task/user
@@ -96,12 +100,19 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
 In general, the task item can be anything and is handled by the specific protocol template.
 For the standard ones (ESA, DA, MQM), we expect each item to be a dictionary (corresponding to a single document unit) that looks as follows:
 ```python
-{   # single document definition
-    "src": ["A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", "toto je pokračování stejného dokumentu"],       # mandatory for ESA/MQM/DA
-    "tgt": ["And suddenly all the water became full of other people and other people.", "this is a continuation of the same document"], # mandatory for ESA/MQM/DA
+# single document definition
+[
+  {
+    "src": "A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", # mandatory for ESA/MQM/DA
+    "tgt": "And suddenly all the water became full of other people and other people." # mandatory for ESA/MQM/DA
+  },
+  {
+    "src": "toto je pokračování stejného dokumentu",
+    "tgt": "this is a continuation of the same document",
     ...  # all other keys that will be stored, useful for your analysis
-},
-... # definition of another item
+  }
+],
+... # definition of another item (document)
 ```
 
 We also support a super simple allocation of annotations (`task-single`, not yet ⚠️), where you simply pass a list of all examples to be evaluated and they are processed in parallel by all annotators:
@@ -146,6 +157,7 @@ pearmut run
 ## Campaign management
 
 When adding new campaigns or launching pearmut, a management link is shown that gives an overview of annotator progress but also an easy access to the annotation links or resetting the task progress (no data will be lost).
+This is also the place where you can download all progress and collected annotations (these files exist also locally but this might be more convenient).
 
 <img width="800" alt="Management dashboard" src="https://github.com/user-attachments/assets/057899d7-2291-46c7-876f-407c4050a9cb" />
 
@@ -165,9 +177,12 @@ Tip: make sure the elements are already appropriately styled.
 
 ## Development
 
-For the server and frontend locally run:
-
+Pearmut works by running a server that responds to requests from the frontend.
+These requests are not template-based but rather carry only data (which gives flexibility in designing new protocols and interfaces).
+By default, the frontend is served from `static/` which is pre-built when you `pip install pearmut`.
+To make changes locally, clone the repository and run the following, which will recompile the frontend on changes (server changes need server restart):
 ```bash
+cd pearmut
 # watch the frontend for changes (in a separate terminal)
 npm install web/ --prefix web/
 npm run watch --prefix web/
@@ -185,12 +200,15 @@ pearmut run
 Optionally, you can specify `--server` in `pearmut add` and `pearmut run` to show correct URL prefixes.
 The `pearmut run` also accepts `--port` (default 8001). 
 
+If you wish to create a new protocol (referenceable from `info->template`), simply create a new HTML and TS file in `web/src` and add a rule to `webpack.config.js` so that your template gets built.
+A template can call the server for data etc (see [web/src/pointwise.ts](web/src/pointwise.ts) as an exmple).
+
 ## Citation
 
 If you use this work in your paper, please cite as:
 ```bibtex
 @misc{zouhar2025pearmut,
-    author={Vilém Zouhar and others},
+    author={Vilém Zouhar},
     title={Pearmut🍐 Platform for Evaluation and Reviewing of Multilingual Tasks},
     url={https://github.com/zouharvi/pearmut/},
     year={2025},

{pearmut-0.0.6 → pearmut-0.1.0}/pearmut.egg-info/SOURCES.txt

@@ -9,7 +9,6 @@ pearmut.egg-info/requires.txt
 pearmut.egg-info/top_level.txt
 server/app.py
 server/cli.py
-server/model.py
 server/protocols.py
 server/utils.py
 server/static/dashboard.bundle.js

{pearmut-0.0.6 → pearmut-0.1.0}/pearmut.egg-info/requires.txt

@@ -1,6 +1,7 @@
 fastapi>=0.110.0
 uvicorn>=0.29.0
 wonderwords>=3.0.0
+psutil>=7.1.0
 
 [dev]
 pytest

{pearmut-0.0.6 → pearmut-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pearmut"
-version = "0.0.6"
+version = "0.1.0"
 description = "A tool for evaluation of model outputs, primarily MT."
 readme = "README.md"
 license = { text = "apache-2.0" }
@@ -16,6 +16,7 @@ dependencies = [
     "fastapi >= 0.110.0",
     "uvicorn >= 0.29.0",
     "wonderwords >= 3.0.0",
+    "psutil >= 7.1.0",
 ]
 
 [project.optional-dependencies]

{pearmut-0.0.6 → pearmut-0.1.0}/server/app.py

@@ -8,7 +8,7 @@ from fastapi.responses import JSONResponse
 from fastapi.staticfiles import StaticFiles
 from pydantic import BaseModel
 
-from .protocols import get_next_item, log_response, reset_task
+from .protocols import get_next_item, reset_task, update_progress
 from .utils import ROOT, load_progress_data, save_progress_data
 
 os.makedirs(f"{ROOT}/data/outputs", exist_ok=True)
@@ -51,6 +51,7 @@ async def _log_response(request: LogResponseRequest):
     if user_id not in progress_data[campaign_id]:
         return JSONResponse(content={"error": "Unknown user ID"}, status_code=400)
 
+    # append response to the output log
     with open(f"{ROOT}/data/outputs/{campaign_id}.jsonl", "a") as log_file:
         log_file.write(json.dumps(request.payload, ensure_ascii=False) + "\n")
 
@@ -67,7 +68,7 @@ async def _log_response(request: LogResponseRequest):
             for a, b in zip(times, times[1:])
         ])
 
-    log_response(campaign_id, user_id, tasks_data, progress_data, request.item_i, request.payload)
+    update_progress(campaign_id, user_id, tasks_data, progress_data, request.item_i, request.payload)
     save_progress_data(progress_data)
 
     return JSONResponse(content={"status": "ok"}, status_code=200)

{pearmut-0.0.6 → pearmut-0.1.0}/server/cli.py

@@ -1,3 +1,7 @@
+"""
+Command-line interface for managing and running the Pearmut server.
+"""
+
 import argparse
 import hashlib
 import json
@@ -46,8 +50,10 @@ def _run(args_unknown):
     )
 
 
-
 def _add_campaign(args_unknown):
+    """
+    Add a new campaign from a JSON data file.
+    """
     import random
 
     import wonderwords
@@ -80,13 +86,30 @@ def _add_campaign(args_unknown):
         )
         exit(1)
 
+    if "info" not in campaign_data:
+        raise ValueError("Campaign data must contain 'info' field.")
+    if "data" not in campaign_data:
+        raise ValueError("Campaign data must contain 'data' field.")
+    if "type" not in campaign_data["info"]:
+        raise ValueError("Campaign 'info' must contain 'type' field.")
+    if "template" not in campaign_data["info"]:
+        raise ValueError("Campaign 'info' must contain 'template' field.")
+
     # use random words for identifying users
     rng = random.Random(campaign_data["campaign_id"])
     rword = wonderwords.RandomWord(rng=rng)
     if campaign_data["info"]["type"] == "task-based":
         tasks = campaign_data["data"]
+        if not isinstance(tasks, list):
+            raise ValueError("Task-based campaign 'data' must be a list of tasks.")
+        if not all(isinstance(task, list) for task in tasks):
+            raise ValueError("Each task in task-based campaign 'data' must be a list of items.")
         amount = len(tasks)
     elif campaign_data["info"]["type"] == "dynamic":
+        if "num_users" not in campaign_data:
+            raise ValueError("Dynamic campaigns must specify 'num_users'.")
+        if not isinstance(campaign_data["data"], list):
+            raise ValueError("Dynamic campaign 'data' must be a list of items.")
         amount = campaign_data["num_users"]
     else:
         raise ValueError(
@@ -94,6 +117,7 @@ def _add_campaign(args_unknown):
 
     user_ids = []
     while len(user_ids) < amount:
+        # generate random user IDs
         new_id = f"{rword.random_words(amount=1, include_parts_of_speech=['adjective'])[0]}-{rword.random_words(amount=1, include_parts_of_speech=['noun'])[0]}"
         if new_id not in user_ids:
             user_ids.append(new_id)
@@ -150,6 +174,9 @@ def _add_campaign(args_unknown):
 
 
 def main():
+    """
+    Main entry point for the CLI.
+    """
     args = argparse.ArgumentParser()
     args.add_argument('command', type=str, choices=['run', 'add', 'purge'])
     args, args_unknown = args.parse_known_args()

{pearmut-0.0.6 → pearmut-0.1.0}/server/protocols.py

@@ -9,6 +9,9 @@ def get_next_item(
     tasks_data: dict,
     progress_data: dict,
 ) -> JSONResponse:
+    """
+    Get the next item for the user in the specified campaign.
+    """
     if tasks_data[campaign_id]["info"]["type"] == "task-based":
         return get_next_item_taskbased(campaign_id, user_id, tasks_data, progress_data)
     elif tasks_data[campaign_id]["info"]["type"] == "dynamic":
@@ -23,6 +26,9 @@ def get_next_item_taskbased(
     data_all: dict,
     progress_data: dict,
 ) -> JSONResponse:
+    """
+    Get the next item for task-based protocol.
+    """
     if all(progress_data[campaign_id][user_id]["progress"]):
         # all items completed
         # TODO: add check for data quality
@@ -51,7 +57,7 @@ def get_next_item_taskbased(
                 "total": len(data_all[campaign_id]["data"][user_id]),
             },
             "info": {
-                "status_message": data_all[campaign_id]["info"].get("status_message", ""),
+                "instructions": data_all[campaign_id]["info"].get("instructions", ""),
                 "item_i": item_i,
             } | {
                 k: v
@@ -74,6 +80,9 @@ def reset_task(
     tasks_data: dict,
     progress_data: dict,
 ) -> JSONResponse:
+    """
+    Reset the task progress for the user in the specified campaign.
+    """
     if tasks_data[campaign_id]["info"]["type"] == "task-based":
         progress_data[campaign_id][user_id]["progress"] = [False]*len(tasks_data[campaign_id]["data"][user_id])
         progress_data[campaign_id][user_id]["time"] = 0.0
@@ -89,7 +98,7 @@ def reset_task(
     
 
 
-def log_response(
+def update_progress(
     campaign_id: str,
     user_id: str,
     tasks_data: dict,
@@ -97,9 +106,13 @@ def log_response(
     item_i: int,
     payload: Any,
 ) -> JSONResponse:
+    """
+    Log the user's response for the specified item in the campaign.
+    """
     if tasks_data[campaign_id]["info"]["type"] == "task-based":
         # even if it's already set it should be fine
         progress_data[campaign_id][user_id]["progress"][item_i] = True
+        # TODO: log attention checks/quality?
         return JSONResponse(content={"status": "ok"}, status_code=200)
     elif tasks_data[campaign_id]["info"]["type"] == "dynamic":
         return JSONResponse(content={"status": "error", "message": "Dynamic protocol logging not implemented yet."}, status_code=400)

{pearmut-0.0.6 → pearmut-0.1.0}/server/static/assets/style.css

@@ -1,7 +1,7 @@
 body {
     margin: 0;
     padding: 0;
-    background: linear-gradient(135deg, #b9e2a1 0%, #dbcfe7 100%);
+    background: linear-gradient(135deg, #b9e2a1 0%, #e7e2cf 100%);
     background-attachment: fixed;
 }
 
@@ -14,7 +14,7 @@ body {
     width: 30%;
     background-color: #fffc;
     padding: 10px;
-    border-radius: 4px;
+    border-radius: 8px;
     vertical-align: top;
     margin-left: 5px;
 }
@@ -32,25 +32,29 @@ body {
 input[type="button"] {
     background: #fff;
     border: none;
-    border-radius: 5px;
+    border-radius: 8px;
     font-size: large;
+    box-shadow: 0 2px 4px #0001;
 }
 
-.button_navigation.button_selected {
-    background: #8db3ec !important;
-}
 
 input[type="button"]:hover:not(:disabled) {
-    background: #ffe;
+    background: #ffd;
     cursor: pointer;
 }
 
+input[type="button"]:disabled {
+    background: #bbb;
+    cursor: not-allowed;
+}
+
 label {
     user-select: none;
 }
 
 .white-box {
-    border-radius: 5pt;
+    border-radius: 8px;
     background: #fff;
     padding: 15pt;
+    box-shadow: 0 4px 6px #0000001a
 }