Call libcoveocds and pass the filename of some JSON data.

libcoveocds tests/fixtures/common_checks/basic_1.json

It will produce JSON data of the results to standard output. You can pipe this straight into a file to work with.

You can also pass --schema-version 1.X to force it to check against a certain version of the schema.

In some modes, it will also leave directory of data behind. The following options apply to this mode:

• Pass --convert to get it to produce spreadsheets of the data.
• Pass --output-dir output to specify a directory name (default is a name based on the filename).
• Pass --delete to delete the output directory if it already exists (default is to error)
• Pass --exclude-file to avoid copying the original file into the output directory (default is to copy)

(If none of these are specified, it will not leave any files behind)

To use this as a Python library as part of a Python script for validating multiple files or testing, you need to:

1. Install the library with pip:

   pip install libcoveocds

2. Use it in your Python code, for example:

   import os
   import shutil
   import tempfile
   
   from libcoveocds.api import ocds_json_output
   from libcoveocds.config import LibCoveOCDSConfig
   
   
   data_directory = 'path/to/your/directory/with/json/files'
   temporary_directory = tempfile.mkdtemp(dir=tempfile.gettempdir())
   
   config = LibCoveOCDSConfig()
   config.config['cache_all_requests'] = True
   
   for file_name in os.listdir(data_directory):
       file_path = os.path.join(data_directory, file_name)
       try:
           result = ocds_json_output(
               temporary_directory,
               file_path,
               schema_version=None,
               convert=False,
               file_type='json',
               lib_cove_ocds_config=config
           )
      finally:
          shutil.rmtree(temporary_directory)
   
       # Do something with the result. For example:
       if result['validation_errors']:
           for error in result['validation_errors']:
               print(f'Validation error {error} found in file {file_path}')
       else:
           print(f'No validation errors found for {file_path}')

The only code that should be used directly by users is the libcoveocds.config and libcoveocds.api modules.

Other code (in libcore, lib, etc.) should not be used by external users of this library directly, as the structure and use of these may change more frequently.

The output is an object with the following properties:

Note that wherever a schema is used, it is the extended schema (if extensions exist).

Note that this list will exclude codelist errors, which instead appear in additional_closed_codelist_values.

lib-cove-ocds uses the jsonschema module's uniqueItems validator to check for unique OCIDs and IDs.

An array marked with an asterisk is populated from fields in the data, so could be any type (if the data doesn't conform to the schema).

lib-cove-ocds was extracted from [cove](https://github.com/OpenDataServices/cove/tree/fa4441b9413324a740b8dc063ffbf0256a353c55).