Liking cljdoc? Tell your friends :D

com.eldrix.hermes.download


downloadclj

(download nm parameters)

Download the named distribution. Parameters:

  • nm : name of the provider e.g. "uk.nhs/sct-clinical"
  • parameters : a sequence of strings representing alternating key value pairs, or strings of the format key=value

The parameters will depend on the exact nature of the provider. Returns the java.nio.file.Path of the directory containing unzipped files.

Download the named distribution.
Parameters:
- nm         : name of the provider   e.g. "uk.nhs/sct-clinical"
- parameters : a sequence of strings representing alternating key value pairs,
               or strings of the format key=value

The parameters will depend on the exact nature of the provider.
Returns the java.nio.file.Path of the directory containing unzipped files.
sourceraw docstring

download-from-trudclj

(download-from-trud item-identifier {:keys [api-key cache-dir release-date]})

Download an item from TRUD Parameters:

  • item-identifier : item wanted, (e.g. 101)
  • config: a map containing: :api-key : path to file containing TRUD api-key (e.g."/var/hermes/api-key.txt") :cache-dir : TRUD download cache directory (e.g. "/tmp/trud") :release-date : (optional) an ISO 8601 date e.g. "2022-02-03" Returns TRUD metadata about the item specified. See com.eldrix.trud.core/get-latest for information about return value.
Download an item from TRUD
Parameters:
- item-identifier : item wanted, (e.g. 101)
- config: a map containing:
  :api-key : path to file containing TRUD api-key (e.g."/var/hermes/api-key.txt")
  :cache-dir : TRUD download cache directory (e.g. "/tmp/trud")
  :release-date : (optional) an ISO 8601 date e.g. "2022-02-03"
Returns TRUD metadata about the item specified.
See com.eldrix.trud.core/get-latest for information about return value.
sourceraw docstring

parse-provider-parametersclj

(parse-provider-parameters args)

Parse a sequence of string arguments returning a map of keys to values. Arguments can be provided as alternating key value pairs, or as strings of the format key = value.

The following are equivalent:

(parse-provider-parameters ["api-key" "../trud/api-key.txt"])
(parse-provider-parameters ["api-key=../trud/api-key.txt"])
 => {:api-key "../trud/api-key.txt"}
Parse a sequence of string arguments returning a map of keys to values.
Arguments can be provided as alternating key value pairs, or as strings of
the format key = value.

The following are equivalent:
```
(parse-provider-parameters ["api-key" "../trud/api-key.txt"])
(parse-provider-parameters ["api-key=../trud/api-key.txt"])
 => {:api-key "../trud/api-key.txt"}
```
sourceraw docstring

(print-providers)

Placeholder for a more sophisticated future method of printing available providers.

Placeholder for a more sophisticated future method of printing available
providers.
sourceraw docstring

registryclj

A registry of download providers.

A registry of download providers. 
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close