Command-line utilities

class ocdskit.commands.base.StandardInputReader(encoding)

read(buf_size)

class ocdskit.commands.base.BaseCommand(subparsers)

kwargs = {}

add_base_arguments()

Add default arguments to all commands.

add_arguments()

Add arguments specific to this command.

add_argument(*args, **kwargs)

Add an argument to the subparser.

abstractmethod handle()

Run the command.

prefix()

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

items(**kwargs)

Yield the items in the input.

print(data, *, streaming=False)

Print 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.commands.base.OCDSCommand(subparsers)

add_base_arguments()

Add default arguments to all commands.

prefix()

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

items(**kwargs)

Yield the items in the input. If an item is an array, yield each entry of the array.

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

Add arguments for setting package metadata to the subparser.

parse_package_arguments()

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