ds-caselaw-marklogic-api-client 36.0.2__tar.gz → 37.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of ds-caselaw-marklogic-api-client might be problematic. Click here for more details.

Files changed (88) hide show
  1. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/PKG-INFO +1 -1
  2. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/pyproject.toml +1 -1
  3. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/__init__.py +5 -0
  4. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/body.py +6 -3
  5. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/transforms/html.xsl +2 -2
  6. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/LICENSE.md +0 -0
  7. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/README.md +0 -0
  8. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/Client.py +0 -0
  9. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/__init__.py +0 -0
  10. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/client_helpers/__init__.py +0 -0
  11. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/client_helpers/search_helpers.py +0 -0
  12. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/content_hash.py +0 -0
  13. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/errors.py +0 -0
  14. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/factories.py +0 -0
  15. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/identifier_resolution.py +0 -0
  16. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/__init__.py +0 -0
  17. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/exceptions.py +0 -0
  18. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/statuses.py +0 -0
  19. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/documents/xml.py +0 -0
  20. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/__init__.py +0 -0
  21. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/exceptions.py +0 -0
  22. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/fclid.py +0 -0
  23. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/neutral_citation.py +0 -0
  24. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/press_summary_ncn.py +0 -0
  25. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/identifiers/unpacker.py +0 -0
  26. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/judgments.py +0 -0
  27. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/neutral_citation_mixin.py +0 -0
  28. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/parser_logs.py +0 -0
  29. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/press_summaries.py +0 -0
  30. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/utilities/__init__.py +0 -0
  31. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/utilities/aws.py +0 -0
  32. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/utilities/dates.py +0 -0
  33. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/models/utilities/move.py +0 -0
  34. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/py.typed +0 -0
  35. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/responses/__init__.py +0 -0
  36. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/responses/search_response.py +0 -0
  37. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/responses/search_result.py +0 -0
  38. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/responses/xsl/search_match.xsl +0 -0
  39. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/search_parameters.py +0 -0
  40. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/types.py +0 -0
  41. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xml_helpers.py +0 -0
  42. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/break_judgment_checkout.xqy +0 -0
  43. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/checkin_judgment.xqy +0 -0
  44. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/checkout_judgment.xqy +0 -0
  45. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/copy_document.xqy +0 -0
  46. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/delete_judgment.xqy +0 -0
  47. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/document_collections.xqy +0 -0
  48. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/document_exists.xqy +0 -0
  49. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_combined_stats_table.xqy +0 -0
  50. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_components_for_document.xqy +0 -0
  51. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_highest_enrichment_version.xqy +0 -0
  52. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_highest_parser_version.xqy +0 -0
  53. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_judgment.xqy +0 -0
  54. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_judgment_checkout_status.xqy +0 -0
  55. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_judgment_version.xqy +0 -0
  56. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_last_modified.xqy +0 -0
  57. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_next_document_sequence_number.xqy +0 -0
  58. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_pending_enrichment_for_version.xqy +0 -0
  59. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_pending_parse_for_version.xqy +0 -0
  60. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_properties_for_search_results.xqy +0 -0
  61. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_property.xqy +0 -0
  62. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_property_as_node.xqy +0 -0
  63. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_recently_enriched.xqy +0 -0
  64. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_recently_parsed.xqy +0 -0
  65. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_version_annotation.xqy +0 -0
  66. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/get_version_created.xqy +0 -0
  67. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/insert_document.xqy +0 -0
  68. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/list_judgment_versions.xqy +0 -0
  69. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/resolve_from_identifier_slug.xqy +0 -0
  70. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/resolve_from_identifier_value.xqy +0 -0
  71. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_boolean_property.xqy +0 -0
  72. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_citation.xqy +0 -0
  73. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_court.xqy +0 -0
  74. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_jurisdiction.xqy +0 -0
  75. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_name.xqy +0 -0
  76. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_this_uri.xqy +0 -0
  77. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_metadata_work_expression_date.xqy +0 -0
  78. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_property.xqy +0 -0
  79. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/set_property_as_node.xqy +0 -0
  80. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/update_document.xqy +0 -0
  81. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/update_locked_judgment.xqy +0 -0
  82. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/user_has_privilege.xqy +0 -0
  83. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/user_has_role.xqy +0 -0
  84. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/validate_all_documents.xqy +0 -0
  85. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/validate_document.xqy +0 -0
  86. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/xslt.xqy +0 -0
  87. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery/xslt_transform.xqy +0 -0
  88. {ds_caselaw_marklogic_api_client-36.0.2 → ds_caselaw_marklogic_api_client-37.0.0}/src/caselawclient/xquery_type_dicts.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: ds-caselaw-marklogic-api-client
3
- Version: 36.0.2
3
+ Version: 37.0.0
4
4
  Summary: An API client for interacting with the underlying data in Find Caselaw.
5
5
  Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
6
6
  Keywords: national archives,caselaw
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "ds-caselaw-marklogic-api-client"
3
- version = "36.0.2"
3
+ version = "37.0.0"
4
4
  description = "An API client for interacting with the underlying data in Find Caselaw."
5
5
  authors = ["The National Archives"]
6
6
  homepage = "https://github.com/nationalarchives/ds-caselaw-custom-api-client"
@@ -1,4 +1,5 @@
1
1
  import datetime
2
+ import os
2
3
  import warnings
3
4
  from functools import cached_property
4
5
  from typing import TYPE_CHECKING, Any, Optional
@@ -529,3 +530,7 @@ class Document:
529
530
  Document(resolution.document_uri.as_document_uri(), api_client=self.api_client)
530
531
  for resolution in resolutions
531
532
  ]
533
+
534
+ def content_as_html(self) -> str | None:
535
+ xlst_image_location = os.getenv("XSLT_IMAGE_LOCATION", "")
536
+ return self.body.content_html(f"{xlst_image_location}/{self.uri}")
@@ -137,8 +137,11 @@ class DocumentBody:
137
137
  return False
138
138
 
139
139
  @cache
140
- def content_as_html(self, image_base_url: Optional[str] = None) -> Optional[str]:
140
+ def content_html(self, image_prefix: str) -> Optional[str]:
141
141
  """Convert the XML representation of the Document into HTML for rendering."""
142
+ """This used to be called content_as_html but we have changed the parameter passed to it from the
143
+ domain of the assets to the path in which the assets are stored (from assets to assets/d-a1b2c3)
144
+ and made the image_prefix mandatory"""
142
145
  if not self.has_content:
143
146
  return None
144
147
 
@@ -150,8 +153,8 @@ class DocumentBody:
150
153
 
151
154
  executable = xslt_processor.compile_stylesheet(stylesheet_file=html_xslt_location)
152
155
 
153
- if image_base_url:
154
- executable.set_parameter("image-base", proc.make_string_value(image_base_url))
156
+ if image_prefix:
157
+ executable.set_parameter("image-prefix", proc.make_string_value(image_prefix))
155
158
 
156
159
  return str(executable.transform_to_string(xdm_node=document))
157
160
 
@@ -13,7 +13,7 @@
13
13
  <xsl:strip-space elements="*" />
14
14
  <xsl:preserve-space elements="p block num heading span a courtType date docDate docTitle docketNumber judge lawyer location neutralCitation party role time" />
15
15
 
16
- <xsl:param name="image-base" as="xs:string" select="'https://assets.caselaw.nationalarchives.gov.uk/'" />
16
+ <xsl:param name="image-prefix" as="xs:string" />
17
17
 
18
18
  <xsl:function name="uk:link-is-supported" as="xs:boolean">
19
19
  <xsl:param name="href" as="attribute()?" />
@@ -741,7 +741,7 @@
741
741
  </xsl:template>
742
742
  <xsl:template match="img/@src">
743
743
  <xsl:attribute name="src">
744
- <xsl:sequence select="concat($image-base, $doc-id, '/', .)" />
744
+ <xsl:sequence select="concat($image-prefix, '/', .)" />
745
745
  </xsl:attribute>
746
746
  </xsl:template>
747
747