ds-caselaw-marklogic-api-client 36.0.1__py3-none-any.whl → 37.0.0__py3-none-any.whl

caselawclient/models/documents/__init__.py

@@ -1,4 +1,5 @@
 import datetime
+import os
 import warnings
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Optional
@@ -529,3 +530,7 @@ class Document:
             Document(resolution.document_uri.as_document_uri(), api_client=self.api_client)
             for resolution in resolutions
         ]
+
+    def content_as_html(self) -> str | None:
+        xlst_image_location = os.getenv("XSLT_IMAGE_LOCATION", "")
+        return self.body.content_html(f"{xlst_image_location}/{self.uri}")

caselawclient/models/documents/body.py

@@ -137,8 +137,11 @@ class DocumentBody:
         return False
 
     @cache
-    def content_as_html(self, image_base_url: Optional[str] = None) -> Optional[str]:
+    def content_html(self, image_prefix: str) -> Optional[str]:
         """Convert the XML representation of the Document into HTML for rendering."""
+        """This used to be called content_as_html but we have changed the parameter passed to it from the
+        domain of the assets to the path in which the assets are stored (from assets to assets/d-a1b2c3)
+        and made the image_prefix mandatory"""
         if not self.has_content:
             return None
 
@@ -150,8 +153,8 @@ class DocumentBody:
 
             executable = xslt_processor.compile_stylesheet(stylesheet_file=html_xslt_location)
 
-            if image_base_url:
-                executable.set_parameter("image-base", proc.make_string_value(image_base_url))
+            if image_prefix:
+                executable.set_parameter("image-prefix", proc.make_string_value(image_prefix))
 
             return str(executable.transform_to_string(xdm_node=document))
 

caselawclient/models/documents/transforms/html.xsl

@@ -13,7 +13,7 @@
 <xsl:strip-space elements="*" />
 <xsl:preserve-space elements="p block num heading span a courtType date docDate docTitle docketNumber judge lawyer location neutralCitation party role time" />
 
-<xsl:param name="image-base" as="xs:string" select="'https://assets.caselaw.nationalarchives.gov.uk/'" />
+<xsl:param name="image-prefix" as="xs:string" />
 
 <xsl:function name="uk:link-is-supported" as="xs:boolean">
 	<xsl:param name="href" as="attribute()?" />
@@ -741,7 +741,7 @@
 </xsl:template>
 <xsl:template match="img/@src">
 	<xsl:attribute name="src">
-		<xsl:sequence select="concat($image-base, $doc-id, '/', .)" />
+		<xsl:sequence select="concat($image-prefix, '/', .)" />
 	</xsl:attribute>
 </xsl:template>
 

caselawclient/models/identifiers/neutral_citation.py

@@ -8,7 +8,7 @@ from caselawclient.types import DocumentIdentifierSlug
 from . import Identifier, IdentifierSchema
 from .exceptions import IdentifierValidationException
 
-VALID_NCN_PATTERN = re.compile(r"(^\[([0-9]{4})\] ([a-zA-Z]+)(?: ([a-zA-Z]+))? ([0-9]+)(?: \(([a-zA-Z]+)\))?$)")
+VALID_NCN_PATTERN = re.compile(r"(^\[([0-9]{4})\] ([a-zA-Z]+)(?: ([a-zA-Z]+))? ([0-9]+)(?: \(([a-zA-Z0-9]+)\))?$)")
 """
 This is a catch-all pattern for anything which looks like a Neutral Citation, even if the court itself isn't valid. Checking that an NCN is plausibly correct is handled elsewhere.
 

{ds_caselaw_marklogic_api_client-36.0.1.dist-info → ds_caselaw_marklogic_api_client-37.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 36.0.1
+Version: 37.0.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw

{ds_caselaw_marklogic_api_client-36.0.1.dist-info → ds_caselaw_marklogic_api_client-37.0.0.dist-info}/RECORD

@@ -7,16 +7,16 @@ caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
 caselawclient/factories.py,sha256=MiOwS44w6zCGZEfYdZT5x5RL8CeBIvUmiBYYWuNbC-0,6942
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=7U5oN2b8JZV9sFSYglBg2K7fKKQgDjTVU5FT22URx7U,19043
-caselawclient/models/documents/body.py,sha256=mhPOV1cOF3RJr69UzNPlo1KrzePaj7KDPYi1exP06L0,5880
+caselawclient/models/documents/__init__.py,sha256=TatleqbzvvNYa9el9NauiB0g9b7VhmdRSzL-tskrqXA,19241
+caselawclient/models/documents/body.py,sha256=IVcuSbgA7SvCvii_VE8MZy_54enDZY8VPoESkUDgfKU,6114
 caselawclient/models/documents/exceptions.py,sha256=Mz1P8uNqf5w6uLnRwJt6xK7efsVqtd5VA-WXUUH7QLk,285
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
-caselawclient/models/documents/transforms/html.xsl,sha256=oSSO-IBX4qLiSWexQYmWJfGNevF09aCBx4D1NYqXxpo,38322
+caselawclient/models/documents/transforms/html.xsl,sha256=XyUQLFcJ7_GwthWQ6ShU0bmzrgpl7xDFU-U8VLgOvEs,38258
 caselawclient/models/documents/xml.py,sha256=HlmPb63lLMnySSOLP4iexcAyQiLByKBZtTd25f8sY8M,1268
 caselawclient/models/identifiers/__init__.py,sha256=_iAsx_e-Rxq3ED3TQQ5Vg1ZNnQn6AZQK8QCvHSFhdGg,6848
 caselawclient/models/identifiers/exceptions.py,sha256=ckVsjPzLuTXkbd7KZRJXoxcltQCXPGL2rMyYwE5orgg,177
 caselawclient/models/identifiers/fclid.py,sha256=Gq0G0eLdUH3j7VybluqJGVcHV3Y-hpjty1OdR91dI5Q,1453
-caselawclient/models/identifiers/neutral_citation.py,sha256=cgB1PO44ra8dKsYGq9_g53be8T1mQatq9Hh_DN5DVg0,2868
+caselawclient/models/identifiers/neutral_citation.py,sha256=mFc-nYDIkLf5fM2eTSBnBigVgxuDcUF2HuMwQYEYeXY,2871
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=CKhNTnO6pfriS4Sg-gt0Pf0fRhH53Uf0flULPncJWM4,762
 caselawclient/models/identifiers/unpacker.py,sha256=fKfiuTKaN-71e40PV8BC9PueKjwgfX9Xw3IVdy8mkqg,2299
 caselawclient/models/judgments.py,sha256=r40irgdEID-NeSNLm3OUdUBznMpRSwjD2SJrGlBgP8o,2208
@@ -82,7 +82,7 @@ caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21q
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1trRZdbOoS8,2462
 caselawclient/xquery_type_dicts.py,sha256=21V6PJ0a8lPZuwzQCWeHNo914hdCbCJtOvnqdHcTpKk,6383
-ds_caselaw_marklogic_api_client-36.0.1.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-36.0.1.dist-info/METADATA,sha256=-rEbiJvBPiF_VGPYSsjJoJFlz5m2tJyEQrodrQfF0KA,4206
-ds_caselaw_marklogic_api_client-36.0.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-36.0.1.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-37.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-37.0.0.dist-info/METADATA,sha256=0v9UC-LN07GEm7ci1s3hPeqjiHpJUbMdqpLloSGJzA0,4206
+ds_caselaw_marklogic_api_client-37.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-37.0.0.dist-info/RECORD,,