dsw-models 4.27.0__py3-none-any.whl

dsw/models/knowledge_model/flat.py

@@ -0,0 +1,230 @@
+import typing
+from uuid import UUID
+
+import pydantic
+
+from .common import (
+    BaseModel,
+    MetricMeasure,
+    QuestionValidation,
+    TAnnotations,
+    THeaders,
+    TQuestionValueType,
+    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[
+    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[
+    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[
+    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,177 @@
+from uuid import UUID
+
+import pydantic
+
+from .common import (
+    BaseModel,
+    QuestionValidation,
+    TAnnotations,
+    TQuestionValueType,
+    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/project/common.py

@@ -0,0 +1,14 @@
+from uuid import UUID
+
+from ..common import BaseModel
+
+
+TODO_LABEL_UUID = UUID('615b9028-5e3f-414f-b245-12d2ae2eeb20')
+
+
+class UserInfo(BaseModel):
+    uuid: UUID
+    first_name: str
+    last_name: str
+    gravatar_hash: str
+    image_url: str | None

dsw/models/project/events.py

@@ -0,0 +1,100 @@
+import typing
+from uuid import UUID, uuid4
+
+import pydantic
+
+from ..common import BaseModel
+from .common import UserInfo
+from .replies import ReplyValue
+
+
+class BaseProjectEvent(BaseModel):
+    uuid: UUID = pydantic.Field(default_factory=uuid4)
+    type: str
+
+
+class BaseProjectPathEvent(BaseProjectEvent):
+    path: str
+
+    @property
+    def path_parts(self) -> list[str]:
+        return self.path.split('.') if self.path else []
+
+
+class SetPhaseEvent(BaseProjectEvent):
+    type: typing.Literal['SetPhaseEvent'] = 'SetPhaseEvent'
+    phase_uuid: UUID | None
+
+
+class SetReplyEvent(BaseProjectPathEvent):
+    type: typing.Literal['SetReplyEvent'] = 'SetReplyEvent'
+    value: ReplyValue
+
+
+class ClearReplyEvent(BaseProjectPathEvent):
+    type: typing.Literal['ClearReplyEvent'] = 'ClearReplyEvent'
+
+
+class SetLabelsEvent(BaseProjectPathEvent):
+    type: typing.Literal['SetLabelsEvent'] = 'SetLabelsEvent'
+    labels: list[UUID]
+
+
+class AddCommentEvent(BaseProjectPathEvent):
+    type: typing.Literal['AddCommentEvent'] = 'AddCommentEvent'
+    thread_uuid: UUID
+    comment_uuid: UUID
+    text: str
+    private: bool = False
+    new_thread: bool
+
+
+class EditCommentEvent(BaseProjectPathEvent):
+    type: typing.Literal['EditCommentEvent'] = 'EditCommentEvent'
+    thread_uuid: UUID
+    comment_uuid: UUID
+    text: str
+    private: bool = False
+
+
+class DeleteCommentEvent(BaseProjectPathEvent):
+    type: typing.Literal['DeleteCommentEvent'] = 'DeleteCommentEvent'
+    thread_uuid: UUID
+    comment_uuid: UUID
+    private: bool = False
+
+
+class AssignCommentThreadEvent(BaseProjectPathEvent):
+    type: typing.Literal['AssignCommentThreadEvent'] = 'AssignCommentThreadEvent'
+    thread_uuid: UUID
+    private: bool = False
+    assigned_to: UserInfo | None
+
+
+class ResolveCommentThreadEvent(BaseProjectPathEvent):
+    type: typing.Literal['ResolveCommentThreadEvent'] = 'ResolveCommentThreadEvent'
+    thread_uuid: UUID
+    private: bool = False
+    comment_count: int
+
+
+class ReopenCommentThreadEvent(BaseProjectPathEvent):
+    type: typing.Literal['ReopenCommentThreadEvent'] = 'ReopenCommentThreadEvent'
+    thread_uuid: UUID
+    private: bool = False
+    comment_count: int
+
+
+ProjectEvent = typing.Annotated[
+    SetPhaseEvent |
+    SetReplyEvent |
+    ClearReplyEvent |
+    SetLabelsEvent |
+    AddCommentEvent |
+    EditCommentEvent |
+    DeleteCommentEvent |
+    AssignCommentThreadEvent |
+    ResolveCommentThreadEvent |
+    ReopenCommentThreadEvent,
+    pydantic.Field(discriminator='type'),
+]

dsw/models/project/files.py

@@ -0,0 +1,15 @@
+import datetime
+from uuid import UUID
+
+from ..common import BaseModel
+
+
+class ProjectFile(BaseModel):
+    uuid: UUID
+    file_name: str
+    content_type: str
+    file_size: int
+    project_uuid: UUID
+    tenant_uuid: UUID
+    created_by: UUID | None
+    created_at: datetime.datetime

dsw/models/project/replies.py

@@ -0,0 +1,94 @@
+import datetime
+import typing
+from uuid import UUID
+
+import pydantic
+
+from ..common import BaseModel
+from .common import UserInfo
+
+
+class BaseIntegrationReplyType(BaseModel):
+    type: str
+
+
+class PlainIntegrationReplyType(BaseIntegrationReplyType):
+    type: typing.Literal['PlainType'] = 'PlainType'
+    content: str
+
+
+class IntegrationLegacyReplyType(BaseIntegrationReplyType):
+    type: typing.Literal['LegacyType'] = 'LegacyType'
+    id: str | None
+    value: str
+
+
+class IntegrationReplyType(BaseModel):
+    type: typing.Literal['IntegrationType'] = 'IntegrationType'
+    value: str
+    raw: pydantic.Json[dict[str, typing.Any]]
+
+
+IntegrationReply = typing.Annotated[
+    PlainIntegrationReplyType |
+    IntegrationLegacyReplyType |
+    IntegrationReplyType,
+    pydantic.Field(discriminator='type'),
+]
+
+
+class BaseReplyValue(BaseModel):
+    type: str
+
+
+class StringReplyValue(BaseReplyValue):
+    type: typing.Literal['StringReply'] = 'StringReply'
+    value: str
+
+
+class AnswerReplyValue(BaseReplyValue):
+    type: typing.Literal['AnswerReply'] = 'AnswerReply'
+    value: UUID
+
+
+class MultiChoiceReplyValue(BaseReplyValue):
+    type: typing.Literal['MultiChoiceReply'] = 'MultiChoiceReply'
+    value: list[UUID]
+
+
+class ItemListReplyValue(BaseReplyValue):
+    type: typing.Literal['ItemListReply'] = 'ItemListReply'
+    value: list[str]
+
+
+class IntegrationReplyValue(BaseReplyValue):
+    type: typing.Literal['IntegrationReply'] = 'IntegrationReply'
+    value: IntegrationReply
+
+
+class ItemSelectionReplyValue(BaseReplyValue):
+    type: typing.Literal['ItemSelectReply'] = 'ItemSelectReply'
+    value: UUID
+
+
+class FileReplyValue(BaseReplyValue):
+    type: typing.Literal['FileReply'] = 'FileReply'
+    value: UUID
+
+
+ReplyValue = typing.Annotated[
+    StringReplyValue |
+    AnswerReplyValue |
+    MultiChoiceReplyValue |
+    ItemListReplyValue |
+    IntegrationReplyValue |
+    ItemSelectionReplyValue |
+    FileReplyValue,
+    pydantic.Field(discriminator='type'),
+]
+
+
+class Reply(BaseModel):
+    value: ReplyValue
+    created_by: UserInfo | None
+    created_at: datetime.datetime

dsw_models-4.27.0.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.3
+Name: dsw-models
+Version: 4.27.0
+Summary: Library with DSW models and basic IO operations
+Keywords: dsw,config,yaml,parser
+Author: Marek Suchánek
+Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
+License: Apache License 2.0
+Classifier: Development Status :: 4 - Beta
+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-Dist: pydantic
+Requires-Python: >=3.12, <4
+Project-URL: Homepage, https://ds-wizard.org
+Project-URL: Repository, https://github.com/ds-wizard/engine-tools
+Project-URL: Documentation, https://guide.ds-wizard.org
+Project-URL: Issues, https://github.com/ds-wizard/ds-wizard/issues
+Description-Content-Type: text/markdown
+
+# Data Stewardship Wizard: Models
+
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ds-wizard/engine-tools)](https://github.com/ds-wizard/engine-tools/releases)
+[![PyPI](https://img.shields.io/pypi/v/dsw-config)](https://pypi.org/project/dsw-config/)
+[![LICENSE](https://img.shields.io/github/license/ds-wizard/engine-tools)](LICENSE)
+[![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 relevant transformations*
+
+## Usage
+
+Currently, this library is intended for internal use of DSW tooling only. 
+Enhancements for use in custom scripts are planned for future development.
+
+## License
+
+This project is licensed under the Apache License v2.0 - see the
+[LICENSE](LICENSE) file for more details.