Starts a simple image server that lets you quickly flip through image files from a local directory using your web browser and optionally answering customizable questions about each one
Project description
reviewer #2
This tool starts a simple image server that lets you quickly flip through image files from a local directory using your web browser. Also, it optionally shows a customizable form where you can take notes or answer questions about each image or set of images.
Example use cases:
- manual curation / review of next-gen sequencing data visualization images such as those generated by REViewer for short tandem repeat loci
- machine learning training set creation
- reviewing a pile of photos
Features:
- simple way to flip through many local image files using your web browser
- crawls a top-level directory to find .png, .jpeg, or .svg image files
- top-level web page lists all images
- each image page shows the image, an optional customizable form where you can take notes or answer questions about the image, and next/previous page links
- use subdirectories to group images. Any images found in the same subdirectory will be shown on the same image page. Also,
reviewer2_metadata.json
files can optionally be added to a subdirectory and provide metadata to show at the top of a specific image page.
Install:
python3 -m pip install reviewer2
Run:
python3 -m reviewer2 # start server for all images in the current directory and subdirectories
Below are more examples (all args are optional). Run it with --help
to see the full list of args and descriptions.
python3 -m reviewer2 -x temp -x keyword2 -d /path/dir-with-images # -x are keyword(s) of paths to skip -d is the top level dir to search instead of the current dir
python3 -m reviewer2 -t /path/user_responses.xls # change where user responses get saved (default: reviewer2_form_responses.tsv)
python3 -m reviewer2 -m /path/metadata.tsv # provide a metadata table
After the server is running, open your web browser to http://localhost:8080 to start reviewing images.
Optional Inputs:
-
responses table (
-t
)As users fill in the forms at the top of the image pages, the responses are written to this table.
Default:
reviewer2_form_responses.tsv
-
metadata table (
-m
) :It's often useful to add extra info to the image pages to help with review - such as image descriptions, quality scores, etc. To enable this, there are several ways to specify arbitrary key-value pairs to add to specific image pages. The 1st way is to put a file called
reviewer2_metadata.json
next to the image(s). All keys and values from this file will appear on that image page. The 2nd way is to use-m
to pass in a metadata table (.tsv
or.xls
) with aPath
column + arbitrary other columns. If thePath
value matches the relative directory containing the image(s), entries from that row in the table will be added to this image page.Since the keys and values are treated as html, they can be used to add more complex info - such as colors, text formatting, <img ..> tags with images from other web pages, iframes containing entire sections of external pages, etc.
-
custom form schema (
--form-schema-json
):Path of .json file containing a custom form schema. For the expected format see the FORM_SCHEMA value in https://github.com/bw2/reviewer2/blob/main/reviewer2/__init__a.py
-
~/.reviewer2_config
Most settings that can be provided on the command line can optionally be set via this YAML config file instead.
For more details, run:
python3 -m reviewer2 --help
Development:
To create a local dev instance, run
git clone git@github.com:bw2/reviewer2.git
cd reviewer2
# start server in dev mode:
python3 -m reviewer2 -d /path/dir-with-images --dev-mode
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for reviewer2-0.9.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 840f6579dbe42fd9b696f90e7822cfea0854ed78920f8298d280875553a4a3df |
|
MD5 | afc578c15addad5413a9065522b1a583 |
|
BLAKE2b-256 | 861a7dd34bc39986cd3f3630d55207a08233e0fa616baef12dd326848a63853a |