zih-models 0.1.0__tar.gz

zih_models-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025, TUD Dresden University of Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the " Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

zih_models-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.3
+Name: zih-models
+Version: 0.1.0
+Summary: Pydantic models for ZIH services
+License: MIT
+Author: Ansgar Burchardt
+Author-email: ansgar.burchardt@tu-dresden.de
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Project-URL: Repository, https://gitlab.hrz.tu-chemnitz.de/zih/sde/zih-models
+Description-Content-Type: text/markdown
+
+<!-- SPDX-License-Identifier: MIT -->
+
+# zih-models
+
+Pydantic models for ZIH services
+

zih_models-0.1.0/README.md

@@ -0,0 +1,5 @@
+<!-- SPDX-License-Identifier: MIT -->
+
+# zih-models
+
+Pydantic models for ZIH services

zih_models-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "zih-models"
+version = "0.1.0"
+description = "Pydantic models for ZIH services"
+authors = [
+    {name = "Ansgar Burchardt",email = "ansgar.burchardt@tu-dresden.de"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "pydantic (>=2.11.7,<3.0.0)"
+]
+
+[project.urls]
+repository = "https://gitlab.hrz.tu-chemnitz.de/zih/sde/zih-models"
+
+[tool.poetry]
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.17.0"
+ruff = "^0.12.3"
+isort = "^6.0.1"
+black = "^25.1.0"
+pytest = "^8.4.1"
+
+[tool.black]
+line-length = 79
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+strict = true
+packages = ["zih_models"]
+plugins = ["pydantic.mypy"]
+check_untyped_defs = true
+enable_error_code = "explicit-override"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

zih_models-0.1.0/zih_models/sharepoint_backend/models.py

@@ -0,0 +1,86 @@
+# SPDX-License-Identifier: MIT
+
+"""models for the sharepoint api"""
+
+from enum import IntEnum, StrEnum
+from typing import Annotated, Literal
+
+from pydantic import BaseModel, Field
+
+
+class SharepointNotFoundError(BaseModel):
+    """Return of the api if target not found"""
+
+    detail: Literal["Not Found"] = "Not Found"
+
+
+class SiteType(StrEnum):
+    """possible types of a site"""
+
+    DEFAULT = "default"
+    PROJECT = "project"
+
+
+class Site(BaseModel):
+    """Sharepoint Site"""
+
+    SiteUrl: str
+    SiteId: str
+    Admin1: str | None = None
+    Admin2: str | None = None
+
+
+class Language(StrEnum):
+    """site language"""
+
+    GERMAN = "de"
+    ENGLISH = "en"
+
+
+class SharepointLanguageCodes(IntEnum):
+    """sharepoint language codes"""
+
+    GERMAN = 1031
+    ENGLISH = 1033
+
+
+LanguageMapper = {
+    Language.GERMAN: SharepointLanguageCodes.GERMAN,
+    Language.ENGLISH: SharepointLanguageCodes.ENGLISH,
+}
+
+LanguageMapperLogList = {
+    Language.GERMAN: "Deutsch (Deutschland)",
+    Language.ENGLISH: "Englisch (USA)",
+}
+
+
+class PrivacyLevel(StrEnum):
+    """privacy level of site"""
+
+    NORMAL = "normal"
+    HIGH = "high"
+
+
+class User(BaseModel):
+    """User Object with all Infos Sharepoint needs"""
+
+    login: str
+    mail: str
+
+
+class CreateSiteData(BaseModel):
+    """Sharepoint Site data which is used to create a new Site"""
+
+    applicant: User
+    head: User
+    it_referent: User
+    ticket_number: str
+    org_id: str
+    site_name: str
+    url_name: Annotated[str, Field(max_length=10)]
+    site_type: SiteType
+    purpose: str
+    site_language: Language
+    privacy_level: PrivacyLevel
+    admins: Annotated[list[User], Field(min_length=2, max_length=2)]