<tool
  id="history_metadata_extractor"
  name="History Metadata Extractor"
  version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@"
  profile="21.09"
>
  <description>
    displays information from exported history's jobs_attrs.txt file.
  </description>
  <macros>
    <token name="@TOOL_VERSION@">0.2.0</token>
    <token name="@VERSION_SUFFIX@">0</token>
  </macros>
  <requirements>
    <requirement type="package" version="3.10.5">python</requirement>
  </requirements>
  <stdio>
    <exit_code range="1" level="fatal" description="Missing parameter error" />
    <exit_code range="2" level="fatal" description="Bad parameter's value" />
    <exit_code range="3" level="fatal" description="Missing input file" />
    <exit_code range="4:254" level="fatal" description="Unknown error" />
    <exit_code range="255" level="fatal" description="No any result to output" />
  </stdio>
  <version_command>
    python3 '$__tool_directory__/history_metadata_extractor.py' --version | head -n 1
  </version_command>
  <command>
    <![CDATA[
python3 '$__tool_directory__/history_metadata_extractor.py'
  --jobs-attrs '$jobs_attrs'
  --dataset-attrs '$dataset_attrs'
  --output '$history_visu'
    ]]>
  </command>
  <inputs>
    <param
      argument="--jobs-attrs"
      type="data"
      format="txt"
      label="Exported history's jobs_attrs.txt file"
      help="Export and extract an history. Select the file 'jobs_attrs.txt'"
    />
    <param
      argument="--dataset-attrs"
      type="data"
      format="txt"
      label="Exported history's dataset_attrs.txt file"
      help="Export and extract an history. Select the file 'dataset_attrs.txt'"
    />
  </inputs>
  <outputs>
    <data
      name="history_visu"
      format="html"
      label="history_visu.html"
    />
  </outputs>
  <tests>
    <test>
      <param name="jobs_attrs" value="jobs_attrs.txt" />
      <param name="dataset_attrs" value="datasets_attrs.txt" />
      <output name="history_visu" file="out.html" />
    </test>
  </tests>
  <help><![CDATA[

 * **@AUTHOR**: Lain Pavot - lain.pavot@inrae.fr
 * **@CREATION DATE**: 22/06/2022
 * **@LAST UPDATE DATE**: 08/08/2022
 * **@VERSION**: @TOOL_VERSION@

----

==========================
History Metadata Extractor
==========================

-------
summary
-------

 | This tool xtracts informations from the `jobs_attrs.txt` and
   `datasets_attrs` files in exported histories, and produces an html page
   showing these informations in a kawaii table.

-----
story
-----

 | You have conscientiously stored your Galaxy history exports through the
   years and now need to mine into it. You want to check what has been done
   but you fear the time needed to get all the info by reloading your
   histories into Galaxy for manual mining. You know there is this
   'jobs_attrs.txt' file that contains the golden info, but eh...

 | So unfriendly!

 | Worry no more! The History Metadata Extractor is there for you! Just upload
   your 'jobs_attrs.txt' file and generate a user-friendly summary of the main
   basic info you may be interested in. Tools used, parameters set... The overview
   you have been dreaming of in a nice html file! You're welcome :)

--------------------
How to use this tool
--------------------

Your exported histories are at the zip format.
Extract the history you want to visualize, and upload the following files:

 * jobs_attrs.txt
 * datasets_attrs.txt

Run the History Metadata Extractor tool with these input files. You will get a
HTML file in output. This file can be viewed clicking on the little eye on
the right of the output card in the output panel.

--

Love & Unicorns - Lain
  ]]>
  </help>
</tool>