CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

0.17.0 (2024-10-19)

Removed

• Remove all aggregates except count and unique_ocids_count.

0.16.2 (2024-10-19)

Fixed

• libcoveocds.schema.SchemaOCDS.__init__ no longer sets invalid_version_data if the package version is missing. (Regression in 0.16.1.)

0.16.1 (2024-10-19)

Fixed

• libcoveocds.schema.SchemaOCDS.__init__ no longer errors if the package version is an unhashable type.

0.16.0 (2024-09-28)

Removed

• libcoveocds.api.ocds_json_output no longer accepts a file_type argument.

• Reduce use of libcove. These removals might cause errors:

  • ignore_errors decorator from get_records_aggregates and get_releases_aggregates functions
  • default argument from json.dumps call, for handling decimals

0.15.0 (2024-09-15)

Changed

• Some arguments must be keyword arguments in:

  • libcoveocds.api.ocds_json_output
  • libcoveocds.common_checks.common_checks_ocds
  • libcoveocds.schema.SchemaOCDS.__init__
  • libcoveocds.schema.SchemaOCDS.get_pkg_schema_obj
  • libcoveocds.schema.SchemaOCDS.get_schema_obj

• Drop support for Python 3.8.

0.14.2 (2024-08-23)

Changed

• Add error message if common_checks_ocds() is called in a web context, without dependencies installed.
• Ignore flattentool warnings, specifically.

Fixed

• Reissue unrecognized warnings from process_codelists() and get_schema_obj().

0.14.1 (2024-02-27)

Fixed

• Additional checks are robust to bad data.

0.14.0 (2024-02-27)

Changed

• Create parent directories when using --output-dir.
• Remove the last suffix for the default --output-dir value, instead of all suffixes.
• Update the default configuration with a user-provided partial configuration, instead of requiring a user-provided full configuration.

Fixed

• Use a temporary directory if --delete or --exclude-file are set without --convert or --output-dir.
• Fix the default --output-dir value on Windows.

Removed

• lib-cove-web configuration options (set in Django applications, instead).

0.13.0 (2023-12-20)

Changed

• Drop support for libcove < 0.32.

0.12.7 (2023-11-20)

Fixed

• Don't leak isCodelist property to web context. (Re-added in 0.12.5.)
• Don't error on currency fields in versioned releases.

0.12.6 (2023-07-12)

Fixed

• Include the extension URL in API context. (Changed in 0.12.0.)

0.12.5 (2023-07-11)

Fixed

• Use the correct package schema in documentation URL fragments.
• Use JsonRef proxies to determine the URL fragments for definitions' fields. (Regression in 0.12.4.)
• Report closed codelists errors separately if the field is a string. (Regression in 0.12.0.)
• Report closed codelists errors separately if the field is an array of codes. (Regression in lib-cove 0.19.0.) #115

0.12.4 (2023-07-11)

Fixed

• Eliminate JsonRef proxies to avoid AttributeError: 'JsonRef' object has no attribute 'get' exceptions.

0.12.3 (2023-07-10)

Changed

• Report json_deref_error in API context, only if the errors occur. (Added in 0.12.2.)
• Don't attempt to report invalid_version_data, as an error is raised from ocds_json_output(). (Added in 0.12.2.)
• Cache public methods of SchemaOCDS, so that its instances can be cached.

0.12.2 (2023-07-09)

Added

• Report json_deref_error and invalid_version_data in API context. #109

Changed

• Use OCDS 1.1 if no version field. #110

Fixed

• Allow use of translated codelists in extensions (i.e. with Código heading). #47
• Calculate additional codelist values for record packages, if using lib-cove#125. #106

0.12.1 (2023-07-09)

Fixed

• Fix jsonschema resource for versioned-release-validation-schema.json. (Changed in 0.12.0.)

0.12.0 (2023-07-09)

Added

• Add options to libcoveocds.config.LibCoveOCDSConfig:
  • standard_zip (default None)
  • additional_checks (default "all")
  • skip_aggregates (default False) #43
  • context (default "web")
• Add CLI options:
  • --additional-checks
  • --skip-aggregates
  • --standard-zip

Changed

BREAKING CHANGES:

• libcoveocds.lib.common_checks:
  • Rename get_bad_ocds_prefixes to get_bad_ocid_prefixes.
• libcoveocds.schema.SchemaOCDS:
  • Rename release_data argument to package_data.
  • Remove pkg_schema_name, default_version, default_schema_host attributes.
• libcoveocds.config.LibCoveOCDSConfig:
  • schema_version_choices values are 3-tuples (added tag), instead of 2-tuples.
  • Remove schema_name, schema_item_name, schema_host keys.
• Install dependencies for the web context with the libcoveocds[web] extra.

Other changes:

• libcoveocds.schema.SchemaOCDS:
  • Raise an error if the select_version is invalid in API context.
  • Extensions
    • Create the record package schema correctly, if extensions present. #112
    • Use ocdsextensionregistry to merge extensions. #81
    • Cache all requests made by ocdsextensionregistry by default. Set the REQUESTS_CACHE_EXPIRE_AFTER environment variable to 0 to expire immediately.
    • An extra error message is no longer reported for empty extension URLs. (Already reported as invalid URI.) (0.11.1)
    • Merge an extension even if its metadata is missing or invalid.
    • Use jsonschema's registry instead of lib-cove's resolver.
  • Codelists
    • Log at exception level if the request fails for the standard's codelists, instead of failing silently.
    • Report all non-existing codes being removed by an extension, not only the last.
• Improve performance in API context.
  • Skip the schema description and reference URL for OCID prefix conformance errors.
  • Skip the formatted message, schema title, schema description and reference URL for validation errors.
  • Skip the metadata fields for OCDS extensions.
  • Skip sorting the JSON locations of additional checks.
  • Improve context_api_transform() performance.
  • Use orjson if available to load the input data.
• ocds_json_output determines record_pkg, if not provided.
• CLI validates --schema-version.
• flattentool is optional.
• Drop support for Python 3.7.

Fixed

• Catch unresolvable reference errors in jsonschema, in addition to jsonref. #66

Removed

• The deprecated cache_schema keyword argument to ocds_json_output() and SchemaOCDS() is removed. (0.4.0)

0.11.3 (2023-03-16)

Changed

• Drop support for jsonschema 3.x.

0.11.2 (2023-02-23)

Added

• Allow execution of command-line interface using python -m libcoveocds.

Changed

• Drop support for Python 3.6.

Fixed

• Add support for Bleach 6.

0.11.1 (2022-06-20)

Fixed

• Extract the description of the ocid field in all languages.
• Label an extension as invalid if the extension metadata URL is empty or the release schema patch is not valid JSON.

0.11.0 (2021-05-20)

Changed

• Check the combination of ocid and id is unique in releases, instead of just id open-contracting/cove-ocds#127

0.10.2 (2021-05-13)

Fixed

• Add a record_pkg keyword argument to the ocds_json_output function. Since 0.8.0 (#44), the ocds_json_output function would check record packages against the release package schema.

0.10.1 (2021-04-10)

Added

• Add Python wheels distribution.

0.10.0 (2021-02-25)

Changed

• common_checks_ocds returns more fields on each error dictionary, so that we can replace the message with a translation in cove-ocds
• Update the default config to use branch urls instead of tag urls for the schema. This means patch fixes will automatically be pulled in.

Fixed

• libcoveocds commandline fails for record packages #39

0.9.1 (2020-09-07)

Fixed

• Fix package: Correct version number.

0.9.0 (2020-09-07)

Added

• Add Unique IDs count to aggregates
• Added many options to CLI: convert, output-dir, schema-version, delete, exclude-file

Changed

• Cache all requests in the tests OpenDataServices/lib-cove#59

0.8.0 (2020-08-26)

Changed

• Move OCDS specific code here from lib-cove #44

0.7.6 (2020-08-21)

• Upgrade to OCDS 1.1.5. Fix URL for codelists.

0.7.5 (2020-08-20)

• Upgrade to OCDS 1.1.5.

0.7.4 (2019-10-31)

Fixed

• Needed dependencies were removed. Put back Python Dependencies until we can properly review which ones can be removed and which can't. #31
• Don't error when looking up a path on a empty schema (e.g. due to broken refs)

0.7.3 (2019-09-23)

• Fix package: Indicate readme's encoding.

0.7.2 (2019-09-18)

• Fix package: Declare package dependencies.

0.7.1 (2019-08-21)

Changed

• get_bad_ocds_prefixes no longer tests for hyphens after OCID prefixes, and no longer allows uppercase letters in OCID prefixes.

0.7.0 (2019-06-26)

Changed

• OCDS Version 1.1.4 has been released! Changed default config to match
• The standard site is now available over SSL

0.6.1 (2019-06-14)

Changed

• Load data in ordered to get consistent output

0.6.0 (2019-06-10)

Changed

• Add handling of new additional fields context

0.5.1 (2019-05-31)

Fixed

• When cache_all_requests was on, some requests were not being cached

0.5.0 (2019-05-09)

• Add additional check EmptyFieldCheck for records.

0.4.0 (2019-04-17)

Added

• cache_all_requests config option, off by default.
• Add additional check EmptyFieldCheck for releases.

Changed

• Upgraded lib-cove to v0.6.0
• The cache_schema option to SchemaOCDS and ocds_json_output is now deprecated; but for now it just sets the new cache_all_requests option

0.3.0 (2019-04-01)

Changed

• Remove core code; use libcove instead.

Fixed

• Record ocid now picked up when checking bad ocid prefix.
• Will not error if compiledRelease is not a object.

0.2.2 (2018-11-14)

Fixed

• get_file_type() - could not detect JSON file if extension was not "JSON" and filename had upper case letters in it

0.2.1 (2018-11-13)

Fixed

• Corrected name of key broken in initial creation

0.2.0 (2018-11-13)

Changed

• When duplicate ID's are detected, show a better message OpenDataServices/cove#782
• Add config option for disable_local_refs mode in flatten-tool, default to on.
• Add config option for remove_empty_schema_columns mode in flatten-tool, default to on.

0.1.0 (2018-11-02)

Added

• Added code for class: SchemaOCDS
• Added code for function: common_checks_ocds
• Added code for function: ocds_json_output
• Added CLI