Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency ds-caselaw-marklogic-api-client to v17 #250

Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 30, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
ds-caselaw-marklogic-api-client 5.2.6 -> 17.0.0 age adoption passing confidence

Release Notes

nationalarchives/ds-caselaw-custom-api-client (ds-caselaw-marklogic-api-client)

v17.0.0

Compare Source

  • BREAKING: VersionAnnotation now requires a statement of if the action is automated or not
  • VersionAnnotation can now accept an optional dict of structured payload data
  • VersionAnnotation can now record a user agent string

v16.0.0

Compare Source

  • New versions of a document created with insert_document_xml can now be annotated
  • BREAKING: Renamed save_judgment_xml to update_document_xml
  • BREAKING: All annotations for versions are now mandatory instances of the new VersionAnnotation class

v15.1.2

Compare Source

  • Expose the creation date of a version

v15.1.1

Compare Source

  • Get version annotation for a single document
  • Expose the type of the latest manifestation date of a document

v15.1.0

Compare Source

  • Search results for press summaries now include NCNs
  • Search results now correctly include document status information
  • Latest manifestation datetime is available for documents (including versions)

v15.0.1

Compare Source

  • Bugfix: document_date_as_date shouldn't fail hard if we can't parse it.

v15.0.0

Compare Source

  • Changed is_failure to rely on failed_to_parse, rather than failure in the URI.

  • Added transformation_datetime to Document

  • Added enrichment_datetime to Document

  • Added get_manifestation_datetimes to Document

  • Added get_latest_manifestation_datetime to Document

  • Added versions_as_documents to Document

  • Added is_version to Document

  • Added version_number to Document

v14.1.0

Compare Source

  • Add default user agent string
  • Add functions for overwriting and moving judgments

v14.0.2

Compare Source

  • Fixed neutral_citation property to look within preface tag rather than mainBody for press summaries, due to updated parsing resulting in updated press summary xml structure.
  • Added python-dotenv as a poetry dev dependency to be able to run the new smoketest.py file that connects to a MarkLogic instance.

v14.0.1

Compare Source

  • Fixed Client.set_document_court method
  • Fixed Client.get_document_type_from_uri method

v14.0.0

Compare Source

  • Breaking:: Removed document.is_editable in favour of the more descriptive and better-tested document.failed_to_parse.
  • Add new Document.delete() method.
  • Generalised the set judgment metadata methods to set document metadata methods specifically for name, court and date.

v13.2.1

Compare Source

  • Fix issues blocking push to PyPI

v13.1.0

Compare Source

  • Added get_judgment_xml_bytestring and content_as_xml_bytestring to Client
  • Fixed content_as_xml_tree by making it use content_as_xml_bytestring
  • Made Document class' name, court, document_date_as_string and document_date_as_date work for Press Summaries also.
  • Added neutral_citation property and validation to PressSummary class.
  • Significant improvements to inline documentation of the code.
  • Deprecated: The caselawclient.api_client instance should be considered deprecated. Projects should instead initialise their own instance.

v13.0.0

Compare Source

Breaking changes
  • supplemental/anonymous/sensitive getters/setters removed

  • XQueries which return multiple responses will raise an error

  • Refactored Document class' name, court, document_date_as_string and document_date_as_date (previously judgment_date_...) on Document class and neutral_citation on Judgment class making use of the new cached content_as_xml_tree property.

  • Renamed judgment_date_as_string judgment_date_as_date to document_date_as_string and document_date_as_date respectively.

  • Added content_as_xml_tree cached property to Document class

  • Changed the Document class' content_as_xml to be a cached_property also. [Note: this changelog line previously mistakenly referred to content_as_html.]

  • Removed get_judgment_name, get_judgment_citation, get_judgment_court, get_judgment_work_date from the Client class and associated .xqy files.

  • Add a new MarklogicApiClient.get_document_by_uri method to retrieve a document (of any type) by URI.

  • New get_document_by_uri method on API client returning unique types for Judgments and PressSummarys.

  • New Document.enrich() method to trigger enrichment

v12.0.0

Compare Source

  • Breaking: Renamed Judgment to Document
  • Breaking: Document.judgment_exists is now Document.document_exists

v11.0.1

Compare Source

  • Check for a valid court, rather than an present one
  • Trim whitespace when trying to set an NCN

v11.0.0

Compare Source

  • Breaking: Renamed copy_judgment to copy_document
  • copy_document now adds the document to the appropriate collection based on the uri.

v10.1.0

Compare Source

  • Judgment.validation_failure_messages method for retrieving a list of strings with reasons a judgment cannot be published.

v10.0.1

Compare Source

  • Fixed insert_document_xml to pattern match uris with and add documents to press-summary, not press_summary.

v10.0.0

Compare Source

  • BREAKING: Renamed insert_judgment_xml to insert_document_xml and enhanced it to place a document in the appropriate collection (press_summary or judgment)

v9.0.0

Compare Source

  • BREAKING: Changed SearchParameters dataclass field from q to query
  • Added search_helpers module to allow clients to search and process document search responses in one go.

v8.0.0

Compare Source

  • Added SearchParameters dataclass for use with search functions using the legacy kwargs from Client.advanced_search and new collections field for filtering by collections
  • BREAKING: Changed Client.advanced_search interface to take in SearchParameters as opposed to the legacy kwargs.
  • Added search_and_decode_response and search_judgments_and_decode_response methods to Client
  • Added SearchResponse, SearchResult, SearchResultMetadata classes to encapsulate and process document search responses.

v7.0.0

Compare Source

  • BREAKING: VersionAnnotation now requires a statement of if the action is automated or not
  • VersionAnnotation can now accept an optional dict of structured payload data
  • VersionAnnotation can now record a user agent string

v6.1.0

Compare Source

  • Judgment.publish method will now reject publication in more invalid states (must have a name, must have a valid NCN, must have a court code).
  • Less strict version pinning of dependencies to give downstream package users more flexibility in resolving.

v6.0.0

Compare Source

  • New versions of a document created with insert_document_xml can now be annotated
  • BREAKING: Renamed save_judgment_xml to update_document_xml
  • BREAKING: All annotations for versions are now mandatory instances of the new VersionAnnotation class

v5.3.2

Compare Source

  • Correct import location used in Judgment model, so it's usable when packaged

v5.3.1

Compare Source

  • Fix broken build process

v5.3.0

Compare Source

  • Dependabot now updates dependencies for all new versions, not just security updates
  • Use Poetry for dependency management, to improve robustness
  • Add a Judgment class (copied from Editor Interface) to begin the process of harmonising how various services interface with the data

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - "after 10am every weekday,before 4pm every weekday" in timezone Europe/London.

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Oct 30, 2023
@renovate renovate bot force-pushed the renovate/ds-caselaw-marklogic-api-client-17.x-lockfile branch from 1f5d072 to 46e3e03 Compare October 30, 2023 15:35
@jacksonj04 jacksonj04 enabled auto-merge October 30, 2023 15:40
@jacksonj04 jacksonj04 merged commit 59cee3d into main Oct 30, 2023
6 checks passed
@renovate renovate bot deleted the renovate/ds-caselaw-marklogic-api-client-17.x-lockfile branch October 30, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant