(EDGAR / v5)

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments

main_flx_arg: (optional): totototo

document here the argument

accepted type: <class ‘str’>

closest_year: (optional): False

If the correct year is not available, use the closest oneXXX if false and not the right year, an error is raised??XXX

accepted type: <class ‘bool’>

Yaml template

Please find below a template for a Yaml configuration:

 1datastream:
 2  plugin:
 3    name: EDGAR
 4    version: v5
 5    type: datastream
 6
 7
 8  # Optional arguments
 9  main_flx_arg: XXXXX
10  closest_year: XXXXX