datalad.api.catalog_create

datalad.api.catalog_create(catalog: Path | WebCatalog, metadata=None, config_file=None, force: bool = False)

Create a user-friendly web-based data catalog, with or without metadata.

If the catalog does not exist at the specified location, it will be created. If the catalog exists and the force flag is True, this will overwrite assets of the existing catalog, while catalog metadata remain unchanged.

Parameters:

  • catalog (path-like object | WebCatalog instance) -- an instance of the catalog to be created

  • metadata (path-like object, optional) -- metadata to be added to the catalog after creation

  • force (bool, optional) -- if True, will overwrite assets of an existing catalog

Yields:

status_dict (dict) -- DataLad result record

Examples

Create a new catalog from scratch:

> catalog_create(catalog='/tmp/my-cat')

Create a new catalog at a location where a directory already exists. This will overwrite all catalog content except for metadata.:

> catalog_create(catalog='/tmp/my-cat', force=True)

Create a new catalog and add metadata:

> catalog_create(catalog='/tmp/my-cat', metadata='path/to/metadata.jsonl')

Create a new catalog with a custom configuration:

> catalog_create(catalog='/tmp/my-cat', config_file='path/to/custom_config_file.json')
Parameters:

  • catalog -- Directory where the catalog is located or will be created.

  • metadata -- The metadata records to be added to the catalog. Multiple input types are possible: - a path to a file containing JSON lines - JSON lines from STDIN - a JSON serialized string. [Default: None]

  • config_file -- Path to config file in YAML or JSON format. Default config is read from datalad_catalog/config/config.json. [Default: None]

  • force (bool, optional) -- If content for the user interface already exists in the catalog directory, force this content to be overwritten. Content overwritten with this flag include the 'artwork' and 'assets' directories and the 'index.html' and 'config.json' files. Content in the 'metadata' directory remain untouched. [Default: False]

  • on_failure ({'ignore', 'continue', 'stop'}, optional) -- behavior to perform on failure: 'ignore' any failure is reported, but does not cause an exception; 'continue' if any failure occurs an exception will be raised at the end, but processing other actions will continue for as long as possible; 'stop': processing will stop on first failure and an exception is raised. A failure is any result with status 'impossible' or 'error'. Raised exception is an IncompleteResultsError that carries the result dictionaries of the failures in its failed attribute. [Default: 'continue']

  • result_filter (callable or None, optional) -- if given, each to-be-returned status dictionary is passed to this callable, and is only returned if the callable's return value does not evaluate to False or a ValueError exception is raised. If the given callable supports **kwargs it will additionally be passed the keyword arguments of the original API call. [Default: None]

  • result_renderer -- select rendering mode command results. 'tailored' enables a command- specific rendering style that is typically tailored to human consumption, if there is one for a specific command, or otherwise falls back on the the 'generic' result renderer; 'generic' renders each result in one line with key info like action, status, path, and an optional message); 'json' a complete JSON line serialization of the full result record; 'json_pp' like 'json', but pretty-printed spanning multiple lines; 'disabled' turns off result rendering entirely; '<template>' reports any value(s) of any result properties in any format indicated by the template (e.g. '{path}', compare with JSON output for all key-value choices). The template syntax follows the Python "format() language". It is possible to report individual dictionary values, e.g. '{metadata[name]}'. If a 2nd-level key contains a colon, e.g. 'music:Genre', ':' must be substituted by '#' in the template, like so: '{metadata[music#Genre]}'. [Default: 'tailored']

  • result_xfm ({'datasets', 'successdatasets-or-none', 'paths', 'relpaths', 'metadata'} or callable or None, optional) -- if given, each to-be-returned result status dictionary is passed to this callable, and its return value becomes the result instead. This is different from result_filter, as it can perform arbitrary transformation of the result value. This is mostly useful for top- level command invocations that need to provide the results in a particular format. Instead of a callable, a label for a pre-crafted result transformation can be given. [Default: None]

  • return_type ({'generator', 'list', 'item-or-list'}, optional) -- return value behavior switch. If 'item-or-list' a single value is returned instead of a one-item return value list, or a list in case of multiple return values. None is return in case of an empty list. [Default: 'list']