Command-line utilities

class ocdskit.cli.commands.base.StandardInputReader(encoding)

read(buf_size)

class ocdskit.cli.commands.base.BaseCommand(subparsers)

kwargs = {}

add_base_arguments()

Adds default arguments to all commands.

add_arguments()

Adds arguments specific to this command.

add_argument(*args, **kwargs)

Adds an argument to the subparser.

abstract handle()

Runs the command.

prefix()

Returns the path to the items to process within each input.

items(**kwargs)

Yields the items in the input.

print(data, streaming=False)

Prints JSON data.

Parameters

streaming (bool) – whether to stream output using json.JSONEncoder().iterencode() (it is only more memory efficient if data contains iterators)

class ocdskit.cli.commands.base.OCDSCommand(subparsers)

add_base_arguments()

Adds default arguments to all commands.

prefix()

Returns the path to the items to process within each input.

items(**kwargs)

Yields the items in the input. If an item is an array, yields each entry of the array.

add_package_arguments(infix, prefix='', version='1.1')

Adds arguments for setting package metadata to the subparser.

parse_package_arguments()

Returns package metadata as a dictionary to be used as keyword arguments.