Skip to main content

Galaxy History Evaluator

Galaxy History Evaluator or ghevaluator is a command-line Python tool to compare Galaxy histories to a template workflow and generate a JSON and HTML report files.

Context

Galaxy is an open, web-based platform for data-intensive computational research.

When running their data analysis, Galaxy users create histories storing their data, but also the steps of the data analysis, i.e. the tools used, their versions and parameters.

Galaxy is also used for training where participants follow step-by-step tutorials, stored in Galaxy histories. At the end, participants might want to know if they followed correctly the tutorial and instructors might need to evaluate histories to give feedback and deliver certificates. Evaluating histories manually can be painful and error prone.

Galaxy History Evaluator aims to solve this by providing a command-line tool to compare a Galaxy history to a templare workflow and generate a report in JSON and HTML with difference between the provided history and the expected workflow.

Usage

Galaxy History Evaluator can be used via command-line

$ ghevaluator --help
usage: ghevaluator [-h] -u HISTORY_URL -w WORKFLOW_URL -a APIKEY [-o OUTPUT]

Compare a Galaxy history to a template workflow and generate the JSON and HTML report files

options:
  -h, --help            show this help message and exit
  -u HISTORY_URL, --history_url HISTORY_URL
                        URL to Galaxy history
  -w WORKFLOW_URL, --workflow_url WORKFLOW_URL
                        URL to template workflow
  -a APIKEY, --apikey APIKEY
                        Galaxy API key
  -o OUTPUT, --output OUTPUT
                        Path to output directory

Installation

Galaxy History Evaluator can be installed with pip:

$ pip install ghevaluator

Tests

  1. Export the Galaxy API key as environment variable
$ export GALAXY_API_KEY=<REPLACE_WITH_GALAXY_API_KEY>
  1. Run the unit tests
$ make test

Documentation

Documentation could be found at https://streetscience.community/ghevaluator/

To update it:

  1. Make the changes in src/docs

  2. Generate the doc with

    $ make html
    

Metadata

Release files for ghevaluator 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ghevaluator 2.1.1
File Size Uploaded Provenance Actions
ghevaluator-2.1.1.tar.gz 19.7 kB Without provenance Details for ghevaluator-2.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ghevaluator 2.1.1
File Interpreter ABI Platform Actions
ghevaluator-2.1.1-py3-none-any.whl Python 3 none any Details for ghevaluator-2.1.1-py3-none-any.whl

Total release size: 48.8 kB

Release files / ghevaluator-2.1.1.tar.gz

Download URL ghevaluator-2.1.1.tar.gz
Size 19.7 kB
Tags Source
SHA-256 checksum
How to use checksums
621efde1aadf9bdfad2b93fec906f9a1ed7e994fc4682b3df7da3da673027ff1
BLAKE2b-256 checksum
How to use checksums
6908fc767889250fddbcdcd58c5ddec9ca9b57a02717e4b3d588f9361810b23a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release files / ghevaluator-2.1.1-py3-none-any.whl

Download URL ghevaluator-2.1.1-py3-none-any.whl
Size 29.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3b57bded9923e205a2e1fe4cf137ea871c4284ae51455b9ae3e45c7cad24502d
BLAKE2b-256 checksum
How to use checksums
da397e617df4a5842e248a3ead55780e14342eb22ccdedaaf482e2ff67ff751f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Security for ghevaluator 2.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page