pearmut 0.0.5__tar.gz → 0.1.0__tar.gz

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pearmut
-Version: 0.0.5
+Version: 0.1.0
 Summary: A tool for evaluation of model outputs, primarily MT.
 Author-email: Vilém Zouhar <vilem.zouhar@gmail.com>
-License: MIT
+License: apache-2.0
 Project-URL: Repository, https://github.com/zouharvi/pearmut
 Project-URL: Issues, https://github.com/zouharvi/pearmut/issues
 Keywords: evaluation,machine translation,human evaluation,annotation
@@ -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" />
 
-## Getting started fast
+## 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" />
 
@@ -154,11 +166,23 @@ An intentionally incorrect token can be shown if the annotations don't pass qual
 
 <img width="500" alt="Token on completion" src="https://github.com/user-attachments/assets/4b4d2aa9-7bab-44d6-894b-6c789cd3bc6e" />
 
-## Development
+## Multimodal Annotations
+
+We also support anything HTML-compatible both on the input and on the output.
+This includes embedded YouTube videos, or even simple `<video ` tags that point to some resource somewhere.
+For an example, try [examples/mock_multimodal.json](examples/mock_multimodal.json).
+Tip: make sure the elements are already appropriately styled.
 
-For the server and frontend locally run:
+<img width="800" alt="Preview of multimodal elements in Pearmut" src="https://github.com/user-attachments/assets/f34a1a3e-ad95-4114-95ee-8a49e8003faf" />
 
+## Development
+
+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/
@@ -169,16 +193,22 @@ pip3 install -e .
 # sets up progress/log files in current working folder
 pearmut add examples/wmt25_#_en-cs_CZ.json
 pearmut add examples/wmt25_#_cs-de_DE.json
-# shows a management link for all loaded campaigns
+# shows a management link for all loaded campaigns and reload on change
 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.5 → 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" />
 
-## Getting started fast
+## 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" />
 
@@ -134,11 +145,23 @@ An intentionally incorrect token can be shown if the annotations don't pass qual
 
 <img width="500" alt="Token on completion" src="https://github.com/user-attachments/assets/4b4d2aa9-7bab-44d6-894b-6c789cd3bc6e" />
 
-## Development
+## Multimodal Annotations
+
+We also support anything HTML-compatible both on the input and on the output.
+This includes embedded YouTube videos, or even simple `<video ` tags that point to some resource somewhere.
+For an example, try [examples/mock_multimodal.json](examples/mock_multimodal.json).
+Tip: make sure the elements are already appropriately styled.
 
-For the server and frontend locally run:
+<img width="800" alt="Preview of multimodal elements in Pearmut" src="https://github.com/user-attachments/assets/f34a1a3e-ad95-4114-95ee-8a49e8003faf" />
 
+## Development
+
+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/
@@ -149,16 +172,22 @@ pip3 install -e .
 # sets up progress/log files in current working folder
 pearmut add examples/wmt25_#_en-cs_CZ.json
 pearmut add examples/wmt25_#_cs-de_DE.json
-# shows a management link for all loaded campaigns
+# shows a management link for all loaded campaigns and reload on change
 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.5 → pearmut-0.1.0}/pearmut.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pearmut
-Version: 0.0.5
+Version: 0.1.0
 Summary: A tool for evaluation of model outputs, primarily MT.
 Author-email: Vilém Zouhar <vilem.zouhar@gmail.com>
-License: MIT
+License: apache-2.0
 Project-URL: Repository, https://github.com/zouharvi/pearmut
 Project-URL: Issues, https://github.com/zouharvi/pearmut/issues
 Keywords: evaluation,machine translation,human evaluation,annotation
@@ -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" />
 
-## Getting started fast
+## 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" />
 
@@ -154,11 +166,23 @@ An intentionally incorrect token can be shown if the annotations don't pass qual
 
 <img width="500" alt="Token on completion" src="https://github.com/user-attachments/assets/4b4d2aa9-7bab-44d6-894b-6c789cd3bc6e" />
 
-## Development
+## Multimodal Annotations
+
+We also support anything HTML-compatible both on the input and on the output.
+This includes embedded YouTube videos, or even simple `<video ` tags that point to some resource somewhere.
+For an example, try [examples/mock_multimodal.json](examples/mock_multimodal.json).
+Tip: make sure the elements are already appropriately styled.
 
-For the server and frontend locally run:
+<img width="800" alt="Preview of multimodal elements in Pearmut" src="https://github.com/user-attachments/assets/f34a1a3e-ad95-4114-95ee-8a49e8003faf" />
 
+## Development
+
+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/
@@ -169,16 +193,22 @@ pip3 install -e .
 # sets up progress/log files in current working folder
 pearmut add examples/wmt25_#_en-cs_CZ.json
 pearmut add examples/wmt25_#_cs-de_DE.json
-# shows a management link for all loaded campaigns
+# shows a management link for all loaded campaigns and reload on change
 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.5 → pearmut-0.1.0}/pearmut.egg-info/SOURCES.txt

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

{pearmut-0.0.5 → 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.5 → pearmut-0.1.0}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "pearmut"
-version = "0.0.5"
+version = "0.1.0"
 description = "A tool for evaluation of model outputs, primarily MT."
 readme = "README.md"
-license = { text = "MIT" }
+license = { text = "apache-2.0" }
 requires-python = ">=3.12"
 authors = [{ name = "Vilém Zouhar", email = "vilem.zouhar@gmail.com" }]
 keywords = [
@@ -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.5/server/run.py → pearmut-0.1.0/server/app.py

@@ -1,6 +1,5 @@
 import json
 import os
-import urllib
 from typing import Any
 
 from fastapi import FastAPI, Query
@@ -9,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)
@@ -32,15 +31,6 @@ for campaign_id in progress_data.keys():
     with open(f"{ROOT}/data/tasks/{campaign_id}.json", "r") as f:
         tasks_data[campaign_id] = json.load(f)
 
-if tasks_data:
-    # print access dashboard URL for all campaigns
-    print(
-        list(tasks_data.values())[0]["info"]["url"] + "/dashboard.html?" + "&".join([
-            f"campaign_id={urllib.parse.quote_plus(campaign_id)}&token={campaign_data["token"]}"
-            for campaign_id, campaign_data in tasks_data.items()
-        ])
-    )
-
 
 class LogResponseRequest(BaseModel):
     campaign_id: str
@@ -61,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")
 
@@ -77,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)
@@ -214,4 +205,4 @@ app.mount(
     "/",
     StaticFiles(directory=f"{os.path.dirname(os.path.abspath(__file__))}/static/" , html=True, follow_symlink=True),
     name="static",
-)
+)