dsp-tools 9.1.0.post11__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/xmllib/models/values.py

@@ -1,428 +0,0 @@
-from __future__ import annotations
-
-import warnings
-from dataclasses import dataclass
-from typing import Any
-from typing import Protocol
-
-from lxml import etree
-
-from dsp_tools.models.custom_warnings import DspToolsUserWarning
-from dsp_tools.utils.uri_util import is_uri
-from dsp_tools.xmllib.value_checkers import is_bool_like
-from dsp_tools.xmllib.value_checkers import is_color
-from dsp_tools.xmllib.value_checkers import is_date
-from dsp_tools.xmllib.value_checkers import is_decimal
-from dsp_tools.xmllib.value_checkers import is_geoname
-from dsp_tools.xmllib.value_checkers import is_integer
-from dsp_tools.xmllib.value_checkers import is_string_like
-from dsp_tools.xmllib.value_checkers import is_timestamp
-from dsp_tools.xmllib.value_converters import convert_to_bool_string
-
-XML_NAMESPACE_MAP = {None: "https://dasch.swiss/schema", "xsi": "http://www.w3.org/2001/XMLSchema-instance"}
-DASCH_SCHEMA = "{https://dasch.swiss/schema}"
-
-
-class Value(Protocol):
-    value: Any
-    prop_name: str
-    permissions: str | None
-    comment: str | None
-    resource_id: str | None
-
-    def serialise(self) -> etree._Element:
-        raise NotImplementedError
-
-    def make_prop(self) -> etree._Element:
-        raise NotImplementedError
-
-    def make_element(self) -> etree._Element:
-        raise NotImplementedError
-
-
-@dataclass
-class BooleanValue:
-    value: Any
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_bool_like(self.value):
-            _warn_type_mismatch(
-                expected_type="bool", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-        self.value = convert_to_bool_string(self.value)
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}boolean-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}boolean", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class ColorValue:
-    value: Any
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_color(self.value):
-            _warn_type_mismatch(
-                expected_type="color", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}color-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}color", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class DateValue:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_date(self.value):
-            _warn_type_mismatch(
-                expected_type="date", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}date-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}date", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class DecimalValue:
-    value: Any
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_decimal(self.value):
-            _warn_type_mismatch(
-                expected_type="decimal", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}decimal-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}decimal", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class GeonameValue:
-    value: Any
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_geoname(self.value):
-            _warn_type_mismatch(
-                expected_type="geoname", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}geoname-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}geoname", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class IntValue:
-    value: int | str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_integer(self.value):
-            _warn_type_mismatch(
-                expected_type="integer", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}integer-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}integer", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = str(self.value)
-        return ele
-
-
-@dataclass
-class LinkValue:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_string_like(self.value):
-            _warn_type_mismatch(
-                expected_type="string", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}resptr-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}resptr", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-@dataclass
-class ListValue:
-    value: Any
-    list_name: Any
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_string_like(self.value) or not is_string_like(self.list_name):
-            _warn_type_mismatch(
-                expected_type="list", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(
-            f"{DASCH_SCHEMA}list-prop", name=self.prop_name, list=self.list_name, nsmap=XML_NAMESPACE_MAP
-        )
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}list", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-@dataclass
-class SimpleText:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_string_like(self.value):
-            _warn_type_mismatch(
-                expected_type="string", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}text-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"encoding": "utf8"}
-        if self.permissions:
-            attribs["permissions"] = self.permissions
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}text", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-@dataclass
-class Richtext:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_string_like(self.value):
-            _warn_type_mismatch(
-                expected_type="string", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}text-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"encoding": "xml"}
-        if self.permissions:
-            attribs["permissions"] = self.permissions
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}text", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-@dataclass
-class TimeValue:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_timestamp(self.value):
-            _warn_type_mismatch(
-                expected_type="timestamp", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}time-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}time", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-@dataclass
-class UriValue:
-    value: str
-    prop_name: str
-    permissions: str | None = "prop-default"
-    comment: str | None = None
-    resource_id: str | None = None
-
-    def __post_init__(self) -> None:
-        if not is_uri(self.value):
-            _warn_type_mismatch(
-                expected_type="uri", value=self.value, prop_name=self.prop_name, res_id=self.resource_id
-            )
-
-    def serialise(self) -> etree._Element:
-        ele = self.make_prop()
-        ele.append(self.make_element())
-        return ele
-
-    def make_prop(self) -> etree._Element:
-        return etree.Element(f"{DASCH_SCHEMA}uri-prop", name=self.prop_name, nsmap=XML_NAMESPACE_MAP)
-
-    def make_element(self) -> etree._Element:
-        attribs = {"permissions": self.permissions} if self.permissions else {}
-        if self.comment:
-            attribs["comment"] = self.comment
-        ele = etree.Element(f"{DASCH_SCHEMA}uri", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
-        ele.text = self.value
-        return ele
-
-
-def _warn_type_mismatch(expected_type: str, value: Any, prop_name: str, res_id: str | None) -> None:
-    """Emits a warning if a values is not in the expected format."""
-    msg = f"At the following location a '{expected_type}' does not conform to the expected format.\n"
-    msg += f"Resource: {res_id} | " if res_id else ""
-    msg += f"Value: {value} | Property: {prop_name}"
-    warnings.warn(DspToolsUserWarning(msg))

dsp_tools-9.1.0.post11.dist-info/METADATA

@@ -1,130 +0,0 @@
-Metadata-Version: 2.3
-Name: dsp-tools
-Version: 9.1.0.post11
-Summary: DSP-TOOLS is a Python package with a command line interface that helps you interact with a DaSCH service platform (DSP) server.
-Project-URL: Homepage, https://www.dasch.swiss/
-Project-URL: Documentation, https://docs.dasch.swiss/latest/DSP-TOOLS/
-Project-URL: Repository, https://github.com/dasch-swiss/dsp-tools.git
-Author-email: DaSCH - Swiss National Data and Service Center for the Humanities <info@dasch.swiss>
-License-File: LICENSE
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.12
-Requires-Dist: argparse>=1.4.0
-Requires-Dist: jsonpath-ng>=1.6.1
-Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: loguru>=0.7.2
-Requires-Dist: lxml>=5.3.0
-Requires-Dist: namedentities>=1.9.4
-Requires-Dist: networkx>=3.3
-Requires-Dist: openpyxl>=3.1.5
-Requires-Dist: packaging>=24.1
-Requires-Dist: pandas[excel]>=2.2.2
-Requires-Dist: pyld>=2.0.4
-Requires-Dist: pyyaml>=6.0.2
-Requires-Dist: rdflib>=7.0.0
-Requires-Dist: regex>=2024.9.11
-Requires-Dist: requests>=2.32.3
-Requires-Dist: rustworkx>=0.15.1
-Requires-Dist: termcolor>=2.4.0
-Requires-Dist: tqdm>=4.66.5
-Description-Content-Type: text/markdown
-
-[![](https://img.shields.io/pypi/v/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
-[![](https://img.shields.io/pypi/l/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) 
-[![](https://img.shields.io/badge/mypy-blue)](https://github.com/python/mypy) 
-[![](https://img.shields.io/badge/markdownlint-darkgreen)](https://github.com/igorshubovych/markdownlint-cli) 
-[![](https://img.shields.io/badge/markdown%20link%20validator-darkgreen)](https://www.npmjs.com/package/markdown-link-validator) 
-
-# DSP-TOOLS Documentation
-
-DSP-TOOLS is a Python package with a command line interface 
-that helps you interact with a DSP server. 
-A DSP server is a remote server or a local machine 
-where the [DSP-API](https://github.com/dasch-swiss/dsp-api) is running on. 
-
-To install the latest version, run:
-
-```bash
-pip3 install dsp-tools
-```
-
-To update to the latest version run:
-
-```bash
-pip3 install --upgrade dsp-tools
-```
-
-The two main tasks that DSP-TOOLS serves for are:
-
-- **Create a project with its data model(s), described in a JSON file, on a DSP server**  
-  In order to archive your data on the DaSCH Service Platform, 
-  you need a data model that describes your data.
-  The data model is defined in a JSON project definition file 
-  which has to be transmitted to the DSP server. 
-  If the DSP server is aware of the data model for your project, 
-  conforming data can be uploaded into the DSP repository.
-- **Upload data, described in an XML file, to a DSP server that has a project with a matching data model**  
-  Sometimes, data is added in large quantities. 
-  Therefore, DSP-TOOLS allows you to perform bulk imports of your data.
-  In order to do so, the data has to be described in an XML file. 
-  DSP-TOOLS is able to read the XML file 
-  and upload all data to the DSP server.
-
-All functionalities of DSP-TOOLS revolve around these two basic tasks. 
-
-DSP-TOOLS provides the following functionalities:
-
-- [`dsp-tools create`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#create) 
-  creates the project with its data model(s) on a DSP server from a JSON file.
-- [`dsp-tools get`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands#get) 
-  reads a project with its data model(s) from 
-  a DSP server and writes it into a JSON file.
-- [`dsp-tools xmlupload`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#xmlupload) 
-  uploads data from an XML file (bulk data import)
-  and writes the mapping from internal IDs to IRIs into a local file.
-- New workflow for `xmlupload`:
-    - [`dsp-tools upload-files`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#upload-files)
-      uploads all files that are referenced in an XML file to a DSP server.
-    - [`dsp-tools ingest-files`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#ingest-files)
-      kicks off the ingest process, and retrieves the mapping CSV when it is finished.
-    - [`dsp-tools ingest-xmlupload`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#ingest-xmlupload)
-      creates the resources contained in the XML file, using the mapping CSV
-- [`dsp-tools resume-xmlupload`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#resume-xmlupload) 
-  resumes a previously interrupted `xmlupload` or `ingest-xmlupload`.
-- [`dsp-tools excel2json`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#excel2json) 
-  creates an entire JSON project file from a folder with Excel files in it.
-    - [`dsp-tools excel2lists`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#excel2lists)
-      creates the "lists" section of a JSON project file from one or several Excel files. 
-      The resulting section can be integrated into a JSON project file
-      and then be uploaded to a DSP server with `dsp-tools create`.
-    - [`dsp-tools excel2resources`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#excel2resources)
-      creates the "resources" section of a JSON project file from an Excel file. 
-      The resulting section can be integrated into a JSON project file 
-      and then be uploaded to a DSP server with `dsp-tools create`.
-    - [`dsp-tools excel2properties`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#excel2properties)
-      creates the "properties" section of a JSON project file from an Excel file. 
-      The resulting section can be integrated into a JSON project file 
-      and then be uploaded to a DSP server with `dsp-tools create`.
-- [`dsp-tools new-excel2json`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#new-excel2json)
-  does the same as the old `excel2json` command, but the Excel format for the `lists` section has been adapted.
-    - [`dsp-tools new-excel2lists`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#new-excel2lists)
-      does the same as the old `excel2lists` command, but the Excel format has been adapted.
-- [`dsp-tools excel2xml`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#excel2xml) 
-  transforms a data source to XML 
-  if it is already structured according to the DSP specifications.
-- [The module `excel2xml`](https://docs.dasch.swiss/latest/DSP-TOOLS/excel2xml-module) 
-  provides helper methods that can be used in a Python script 
-  to convert data from a tabular format into XML.
-- [`dsp-tools id2iri`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#id2iri)
-  takes an XML file for bulk data import and replaces referenced internal IDs with IRIs. 
-  The mapping has to be provided with a JSON file.
-- [`dsp-tools start-stack / stop-stack`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#start-stack)
-  assist you in running a DSP stack on your local machine.
-- [`dsp-tools template`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#template)
-  creates a template repository with a minimal JSON and XML file.
-- [`dsp-tools rosetta`](https://docs.dasch.swiss/latest/DSP-TOOLS/cli-commands/#rosetta)
-  clones the most up to date rosetta repository,
-  creates the data model and uploads the data.