dsw-models 4.25.1__py2.py3-none-any.whl → 4.26.0__py2.py3-none-any.whl

dsw/models/knowledge_model/flat.py

@@ -0,0 +1,229 @@
+import typing
+from uuid import UUID
+
+import pydantic
+
+from .common import (BaseModel, TAnnotations, TQuestionValueType, THeaders,
+                     MetricMeasure, QuestionValidation, TypeHintExchange)
+
+
+class BaseKMFlatEntity(BaseModel):
+    uuid: UUID
+    annotations: TAnnotations
+
+
+class Answer(BaseKMFlatEntity):
+    label: str
+    advice: str | None
+    metric_measures: list[MetricMeasure]
+    follow_up_uuids: list[UUID]
+
+
+class Chapter(BaseKMFlatEntity):
+    title: str
+    text: str | None
+    question_uuids: list[UUID]
+
+
+class Choice(BaseKMFlatEntity):
+    label: str
+
+
+class Expert(BaseKMFlatEntity):
+    name: str
+    email: str
+
+
+class ApiIntegration(BaseKMFlatEntity):
+    integration_type: typing.Literal['ApiIntegration'] = 'ApiIntegration'
+    name: str
+    variables: list[str]
+    allow_custom_reply: bool
+    request_method: str
+    request_url: str
+    request_headers: THeaders
+    request_body: str | None
+    request_allow_empty_search: bool
+    response_list_field: str | None
+    response_item_template: str
+    response_item_template_for_selection: str | None
+    test_q: str
+    test_variables: dict[str, str]
+    test_response: TypeHintExchange | None
+
+
+class ApiLegacyIntegration(BaseKMFlatEntity):
+    integration_type: typing.Literal['ApiLegacyIntegration'] = 'ApiLegacyIntegration'
+    id: str
+    name: str
+    variables: list[str]
+    logo: str | None
+    request_method: str
+    request_url: str
+    request_headers: THeaders
+    request_body: str | None
+    request_empty_search: bool
+    response_list_field: str | None
+    response_item_id: str | None
+    response_item_template: str | None
+    item_url: str | None
+
+
+class WidgetIntegration(BaseKMFlatEntity):
+    integration_type: typing.Literal['WidgetIntegration'] = 'WidgetIntegration'
+    id: str
+    name: str
+    variables: list[str]
+    logo: str | None
+    widget_url: str
+    item_url: str | None
+
+
+Integration = typing.Annotated[
+    typing.Union[
+        ApiIntegration,
+        ApiLegacyIntegration,
+        WidgetIntegration,
+    ],
+    pydantic.Field(discriminator='integration_type'),
+]
+
+
+class Metric(BaseKMFlatEntity):
+    title: str
+    abbreviation: str | None
+    description: str | None
+
+
+class Phase(BaseKMFlatEntity):
+    title: str
+    description: str | None
+
+
+class QuestionBase(BaseKMFlatEntity):
+    title: str
+    text: str | None
+    required_phase_uuid: UUID | None
+    expert_uuids: list[UUID]
+    reference_uuids: list[UUID]
+    tag_uuids: list[UUID]
+
+
+class OptionsQuestion(QuestionBase):
+    question_type: typing.Literal['OptionsQuestion'] = 'OptionsQuestion'
+    answer_uuids: list[UUID]
+
+
+class MultiChoiceQuestion(QuestionBase):
+    question_type: typing.Literal['MultiChoiceQuestion'] = 'MultiChoiceQuestion'
+    choice_uuids: list[UUID]
+
+
+class ListQuestion(QuestionBase):
+    question_type: typing.Literal['ListQuestion'] = 'ListQuestion'
+    item_template_question_uuids: list[UUID]
+
+
+class ValueQuestion(QuestionBase):
+    question_type: typing.Literal['ValueQuestion'] = 'ValueQuestion'
+    value_type: TQuestionValueType
+    validations: list[QuestionValidation]
+
+
+class IntegrationQuestion(QuestionBase):
+    question_type: typing.Literal['IntegrationQuestion'] = 'IntegrationQuestion'
+    integration_uuid: UUID
+    variables: dict[str, str]
+
+
+class ItemSelectQuestion(QuestionBase):
+    question_type: typing.Literal['ItemSelectQuestion'] = 'ItemSelectQuestion'
+    list_question_uuid: UUID
+
+
+class FileQuestion(QuestionBase):
+    question_type: typing.Literal['FileQuestion'] = 'FileQuestion'
+    max_size: int
+    file_types: str | None
+
+
+Question = typing.Annotated[
+    typing.Union[
+        OptionsQuestion,
+        MultiChoiceQuestion,
+        ListQuestion,
+        ValueQuestion,
+        IntegrationQuestion,
+        ItemSelectQuestion,
+        FileQuestion,
+    ],
+    pydantic.Field(discriminator='question_type'),
+]
+
+
+class ResourcePageReference(BaseKMFlatEntity):
+    reference_type: typing.Literal['ResourcePageReference'] = 'ResourcePageReference'
+    resource_page_uuid: UUID
+
+
+class URLReference(BaseKMFlatEntity):
+    reference_type: typing.Literal['URLReference'] = 'URLReference'
+    url: str
+    label: str
+
+
+class CrossReference(BaseKMFlatEntity):
+    reference_type: typing.Literal['CrossReference'] = 'CrossReference'
+    target_uuid: UUID
+    description: str
+
+
+Reference = typing.Annotated[
+    typing.Union[
+        ResourcePageReference,
+        URLReference,
+        CrossReference,
+    ],
+    pydantic.Field(discriminator='reference_type'),
+]
+
+
+class ResourceCollection(BaseKMFlatEntity):
+    title: str
+    resource_page_uuids: list[UUID]
+
+
+class ResourcePage(BaseKMFlatEntity):
+    title: str
+    content: str
+
+
+class Tag(BaseKMFlatEntity):
+    name: str
+    description: str | None
+    color: str
+
+
+class KnowledgeModelEntities(BaseModel):
+    answers: dict[UUID, Answer]
+    chapters: dict[UUID, Chapter]
+    choices: dict[UUID, Choice]
+    experts: dict[UUID, Expert]
+    integrations: dict[UUID, Integration]
+    metrics: dict[UUID, Metric]
+    phases: dict[UUID, Phase]
+    questions: dict[UUID, Question]
+    references: dict[UUID, Reference]
+    resource_collections: dict[UUID, ResourceCollection]
+    resource_pages: dict[UUID, ResourcePage]
+    tags: dict[UUID, Tag]
+
+
+class KnowledgeModel(BaseKMFlatEntity):
+    entities: KnowledgeModelEntities
+    chapter_uuids: list[UUID]
+    integration_uuids: list[UUID]
+    metric_uuids: list[UUID]
+    phase_uuids: list[UUID]
+    resource_collection_uuids: list[UUID]
+    tag_uuids: list[UUID]

dsw/models/knowledge_model/package.py

@@ -0,0 +1,34 @@
+# pylint: disable=too-many-arguments, too-many-locals, too-many-lines
+import datetime
+
+from .common import BaseModel
+from .events import Event
+
+
+class KnowledgeModelPackage(BaseModel):
+    id: str
+    km_id: str
+    organization_id: str
+    version: str
+    name: str
+    metamodel_version: int
+    description: str
+    license: str
+    readme: str
+    created_at: datetime.datetime
+    fork_of_package_id: str | None
+    merge_checkpoint_package_id: str | None
+    previous_package_id: str | None
+    events: list[Event]
+    non_editable: bool = False
+    phase: str
+
+
+class KnowledgeModelPackageBundle(BaseModel):
+    id: str
+    km_id: str
+    organization_id: str
+    version: str
+    metamodel_version: int
+    name: str
+    packages: list[KnowledgeModelPackage]

dsw/models/knowledge_model/tree.py

@@ -0,0 +1,172 @@
+from uuid import UUID
+
+import pydantic
+
+from .common import (BaseModel, TAnnotations, TQuestionValueType,
+                     QuestionValidation, TypeHintExchange)
+
+
+class BaseKMTreeEntity(BaseModel):
+    uuid: UUID
+    annotations: TAnnotations
+
+
+class MetricMeasure(BaseModel):
+    metric: 'Metric'
+    measure: float = pydantic.Field(ge=0.0, le=1.0)
+    weight: float = pydantic.Field(ge=0.0, le=1.0)
+
+
+class Answer(BaseKMTreeEntity):
+    label: str
+    advice: str | None
+    metric_measures: list[MetricMeasure]
+    follow_ups: list['Question']
+
+
+class Choice(BaseKMTreeEntity):
+    label: str
+
+
+class Expert(BaseKMTreeEntity):
+    name: str
+    email: str
+
+
+class Tag(BaseKMTreeEntity):
+    title: str
+    description: str | None
+    color: str
+
+
+class Phase(BaseKMTreeEntity):
+    name: str
+    description: str | None
+
+
+class Metric(BaseKMTreeEntity):
+    title: str
+    abbreviation: str | None
+    description: str | None
+
+
+class ResourcePage(BaseKMTreeEntity):
+    title: str
+    content: str
+
+
+class ResourceCollection(BaseKMTreeEntity):
+    title: str
+    resource_pages: list[ResourcePage]
+
+
+class Integration(BaseKMTreeEntity):
+    name: str
+    variables: list[str]
+
+
+class ApiIntegration(Integration):
+    allow_custom_reply: bool
+    request_method: str
+    request_url: str
+    request_body: str | None
+    request_allow_empty_search: bool
+    response_list_field: str
+    response_item_template: str
+    response_item_template_for_selection: str | None
+    test_q: str
+    test_variables: dict[str, str]
+    test_response: TypeHintExchange | None
+
+
+class ApiLegacyIntegration(Integration):
+    id: str
+    logo: str | None
+    request_method: str
+    request_url: str
+    request_body: str | None
+    request_empty_search: bool
+    response_list_field: str | None
+    response_item_id: str | None
+    response_item_template: str | None
+    item_url: str | None
+
+
+class WidgetIntegration(Integration):
+    id: str
+    logo: str | None
+    widget_url: str
+    item_url: str | None
+
+
+class Reference(BaseKMTreeEntity):
+    pass
+
+
+class ResourcePageReference(Reference):
+    resource_page: ResourcePage
+
+
+class URLReference(Reference):
+    url: str
+    label: str
+
+
+class CrossReference(Reference):
+    target: BaseKMTreeEntity
+    description: str
+
+
+class Question(BaseKMTreeEntity):
+    title: str
+    text: str
+    required_phase: Phase | None
+    experts: list[Expert]
+    references: list[Reference]
+    tags: list[Tag]
+
+
+class OptionsQuestion(Question):
+    answers: list[Answer]
+
+
+class ChoiceQuestion(Question):
+    choices: list[Choice]
+
+
+class ListQuestion(Question):
+    item_template_questions: list[Question]
+
+
+class ValueQuestion(Question):
+    value_type: TQuestionValueType
+    validations: list[QuestionValidation]
+
+
+class IntegrationQuestion(Question):
+    integration: Integration
+    variables: dict[str, str]
+
+
+class ItemSelectQuestion(Question):
+    list_question: ListQuestion
+
+
+class FileQuestion(Question):
+    max_size: int
+    file_types: str | None
+
+
+class Chapter(BaseKMTreeEntity):
+    title: str
+    description: str
+    questions: list[Question]
+
+
+class KnowledgeModel(BaseKMTreeEntity):
+    chapters: list[Chapter]
+    tags: list[Tag]
+    phases: list[Phase]
+    metrics: list[Metric]
+    integrations: list[Integration]
+    resource_collections: list[ResourceCollection]

{dsw_models-4.25.1.dist-info → dsw_models-4.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dsw-models
-Version: 4.25.1
+Version: 4.26.0
 Summary: Library with DSW models and basic IO operations
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -13,11 +13,13 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Utilities
 Requires-Python: <4,>=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pydantic
 Dynamic: license-file
 
 # Data Stewardship Wizard: Models
@@ -28,7 +30,7 @@ Dynamic: license-file
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4975/badge)](https://bestpractices.coreinfrastructure.org/projects/4975)
 [![Python Version](https://img.shields.io/badge/Python-%E2%89%A5%203.7-blue)](https://python.org)
 
-*Library with DSW models and its basic IO*
+*Library with DSW models and relevant transformations*
 
 ## Usage
 

dsw_models-4.26.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+dsw/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dsw/models/build_info.py,sha256=GYhJZrBL07xEDAD6WxxqOSpaG023814LTEI12UTSb7U,381
+dsw/models/common.py,sha256=vAP-zMKPs9Y4XHeqIwPhpQ5Sfb8jQRx4xpH1lCJMRtc,394
+dsw/models/document_template/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dsw/models/document_template/metadata.py,sha256=x2YeD3LqXi5sKb8d9Ufeph-OxGldRVUxc0OAJJP9tlE,922
+dsw/models/knowledge_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dsw/models/knowledge_model/common.py,sha256=TFPcM7qvPKRyurivDEoJD7XDN8sOC52mQvpijS8b5IU,4825
+dsw/models/knowledge_model/events.py,sha256=r0IJS_43Yztoeq3SBT6KhS0BhwQf1ZoNPbuHMvpyz04,19430
+dsw/models/knowledge_model/flat.py,sha256=Vxx5OBBdSBt0_EZ8yoiqx0TMDiuqG0zLGKWC3vE64H8,5519
+dsw/models/knowledge_model/package.py,sha256=4sm2tJvlGWfhw0UnYX9CmUPA-z17xccmaaaJfVzf0Nk,768
+dsw/models/knowledge_model/tree.py,sha256=cdN4-8FS086F-LQSo8ib-syK1eltpggWIC48XXWu6GY,3322
+dsw_models-4.26.0.dist-info/licenses/LICENSE,sha256=rDtJ4LdsXvf_euOpGD0Q86P78K4JyM5m4yfYz9wZ750,11346
+dsw_models-4.26.0.dist-info/METADATA,sha256=xWQFJWZFeGMDQpZMmrp6i_GhIF0nzIPOnbpYxST8Ey8,1854
+dsw_models-4.26.0.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+dsw_models-4.26.0.dist-info/top_level.txt,sha256=7SfbsHFoJ_vlAgG6C-xzETETwYO71dBrGnod8uMFnjw,4
+dsw_models-4.26.0.dist-info/RECORD,,

dsw/models/io.py

@@ -1,10 +0,0 @@
-import json
-import typing
-
-
-class WizardJSONEncoder(json.JSONEncoder):
-
-    def default(self, o: typing.Any) -> typing.Any:
-        if hasattr(o, 'to_dict') and callable(o.to_dict):
-            return o.to_dict()
-        return super().default(o)