Skip to content

Releases: tool-spec/json2args

v0.7.0

Choose a tag to compare

@github-actions github-actions released this 31 Jul 08:08

json2args

The json2args package can be used in docker container following the Tool specification.
Following these specifications, docker-based and reproducible scientifc tools or workflows can be implemented
upon a set of additional files inside the container. Minimal metadata is added via a tool.yml and the
parameterization and data specification is done via a input.json, mounted along with the data files into the container.

This package is a utility for Python based docker tools, that loads, parses and validates the input parameters.
Optionally, you can use the package to pre-load standard input files into the appropriate Python data strurctures.

from json2args import get_parameter, get_data

params = get_parameter()
iris_dataset = get_data('iris')  # optional

# usage
params['foo']   # can be a string 'bar'
iris_dataset    # This is a pandas.Dataframe, loaded from a standard CSV

What's Changed

Full Changelog: v0.6.2...v0.7.0

v0.6.0

Choose a tag to compare

@github-actions github-actions released this 18 Dec 16:32

json2args

The json2args package can be used in docker container following the Tool specification.
Following these specifications, docker-based and reproducible scientifc tools or workflows can be implemented
upon a set of additional files inside the container. Minimal metadata is added via a tool.yml and the
parameterization and data specification is done via a input.json, mounted along with the data files into the container.

This package is a utility for Python based docker tools, that loads, parses and validates the input parameters.
Optionally, you can use the package to pre-load standard input files into the appropriate Python data strurctures.

from json2args import get_parameter, get_data

params = get_parameter()
iris_dataset = get_data('iris')  # optional

# usage
params['foo']   # can be a string 'bar'
iris_dataset    # This is a pandas.Dataframe, loaded from a standard CSV

What's Changed

Full Changelog: v0.5.3...v0.6.0

Version 0.5

Choose a tag to compare

@mmaelicke mmaelicke released this 15 Dec 05:46

Intermediate version as a starting point to implement the current state of the tool specifications.

Separates data from parameters, with two distinct functions to be used to load either the data from json config files, or pre-load the data from standard file formats.

Version 0.4

Choose a tag to compare

@AlexDo1 AlexDo1 released this 15 Nov 15:33
e064080

Renamed in/tool.json to in/parameters.json as this filename is more accurate.

Version 0.3

Choose a tag to compare

@mmaelicke mmaelicke released this 13 Nov 16:12
6e8f761

Now updated to .dat files

Version 0.2

Choose a tag to compare

@mmaelicke mmaelicke released this 09 Nov 19:24

Minor release with import bugfixes and deprecation warnings.
Now the package should actually work.

Full Changelog: v0.1.0...v0.2.0

Initial release

Choose a tag to compare

@mmaelicke mmaelicke released this 09 Nov 19:12

This is the initial release. It just contains the parameter.py imported from toolbox_runner as a standalone package.
The parse_parameter function has been deprecated in favor of get_parameter, which is as of this writing exactly the same function.