tooaio-scripts 1.0.0__tar.gz

tooaio_scripts-1.0.0/.gitignore

@@ -0,0 +1,22 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+.build/
+build/
+dist/
+wheels/
+*.egg-info
+
+*.key
+*.csr
+*.crt
+*.pfx
+*.pem
+
+.env
+
+# Virtual environments
+.venv
+
+# Releases
+.release*

tooaio_scripts-1.0.0/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

tooaio_scripts-1.0.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: tooaio-scripts
+Version: 1.0.0
+Summary: Скрипты общего назначения: сборка документации, сборка приложений
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: gitpython>=3.1.62
+Requires-Dist: pydantic-settings>=2.12.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: reportlab>=5.0.0
+Description-Content-Type: text/markdown
+
+# Скрипты общего назначения
+  * сборка документации;
+  * сборка приложений;

tooaio_scripts-1.0.0/README.md

@@ -0,0 +1,3 @@
+# Скрипты общего назначения
+  * сборка документации;
+  * сборка приложений;

tooaio_scripts-1.0.0/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "tooaio-scripts"
+version = "1.0.0"
+
+description = """
+Скрипты общего назначения: сборка документации, сборка приложений
+"""
+
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.12.5",
+    "pydantic-settings>=2.12.1",
+    "reportlab>=5.0.0",
+    "gitpython>=3.1.62",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=2.3.0",
+    "ruff>=0.16.1",
+    "types-reportlab>=4.5.1.20260807",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+packages = [
+    "src",
+]
+
+[[tool.uv.index]]
+url = "https://pypi.org/simple/"
+default = true
+
+
+[tool.mypy]
+plugins = [
+    "pydantic.mypy"
+]
+follow_imports = "normal"
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+disallow_untyped_defs = true
+
+[tool.ruff]
+target-version = "py312"
+indent-width = 4
+line-length = 120
+include = [
+    "./src/**/*.py",
+]
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+skip-magic-trailing-comma = false
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes (unused imports, undefined variables)
+    "B",      # flake8-bugbear (common design issues)
+    "A",      # flake8-builtins
+    "S",      # flagk8-bandit (security testing)
+    "BLE",    # flake8-blind-except
+    "FBT",    # flake8-boolean-trap
+    "UP",     # pyupgrade (modernizes syntax)
+    "SIM",    # flake8-simplify (cleans up redundant code)
+    "ANN",    # flake8-annotations
+    "EM",     # flake8-errmsg
+    "DTZ",    # flake8-datetimez
+    "LOG",    # flake8-logging
+    "G",      # flake8-logging-format
+    "ASYNC",  # flake8-simplify (cleans up redundant code)
+]
+ignore = [
+    "I",    # isort (import sorting)
+]

tooaio_scripts-1.0.0/src/build_release_git_remote.py

@@ -0,0 +1,200 @@
+from pathlib import Path
+import subprocess
+import shutil
+from collections.abc import Callable
+from git import Repo, rmtree
+
+
+class ReleaseSafeUtils:
+    def __init__(self, release_path: Path) -> None:
+        self.release_path = release_path
+
+    def __check_path_in_release(self, path: Path) -> None:
+        if not path.resolve().is_relative_to(self.release_path.resolve()):
+            err_msg = f"Путь {path.resolve()} должен быть внутри папки релиза {self.release_path.resolve()}"
+            raise Exception(err_msg)
+
+    def __check_path_not_nested(self, *, not_nested: Path, in_path: Path) -> None:
+        if not_nested.resolve().is_relative_to(in_path.resolve()):
+            err_msg = f"Путь {not_nested.resolve()} не должен быть внутри папки {in_path.resolve()}"
+            raise Exception(err_msg)
+
+    def mkdir_safe(self, path: Path, *, exist_ok: bool = False) -> None:
+        self.__check_path_in_release(path)
+        path.mkdir(exist_ok=exist_ok)
+
+    def rmtree_safe(self, path: Path) -> None:
+        self.__check_path_in_release(path)
+        rmtree(path.resolve())
+
+    def copytree_safe(
+        self, src: Path, dst: Path, *, ignore: Callable[[str, list[str]], list[str]] | None = None
+    ) -> None:
+        self.__check_path_in_release(dst)
+        self.__check_path_not_nested(not_nested=dst, in_path=src)
+        shutil.copytree(src.resolve(), dst.resolve(), ignore=ignore)
+
+    def copyfile_safe(self, src: Path, dst: Path) -> None:
+        self.__check_path_in_release(dst)
+        shutil.copyfile(src.resolve(), dst.resolve())
+
+    def copy_repo_files_safe(self, src_repo: Repo, dst_path: Path) -> None:
+        dst_path = dst_path.resolve()
+
+        if dst_path.exists():
+            self.rmtree_safe(dst_path)
+
+        dst_repo = src_repo.clone(dst_path)
+        self.rmtree_safe(Path(dst_repo.git_dir).resolve())
+
+    def zip_dir_safe(self, *, src_dir: Path, dst_zipfile: Path) -> None:
+        self.__check_path_not_nested(not_nested=dst_zipfile, in_path=src_dir)
+        res_file = shutil.make_archive(
+            base_name=str(dst_zipfile.with_suffix("")),
+            format="zip",
+            root_dir=str(src_dir),
+        )
+        print(res_file)
+
+
+def build_release_git_remote(
+    *,
+    dev_repo_path: Path,
+    release_repo_url: str,
+    release_path: Path,
+    release_dev_repo_path: Path,
+    func_before_dev_repo_clone: Callable[[ReleaseSafeUtils], None] | None = None,
+    func_after_dev_repo_clone: Callable[[ReleaseSafeUtils], None] | None = None,
+) -> ReleaseSafeUtils:
+    """
+    Создание релиза в формате удаленного репозитория,
+    содержащего копию исходного кода из локального репозитория разработчика
+
+    Удаленный репозиторий - репозиторий на стороне заказчика (например, в среде разработки заказчика)
+
+    Удаленный репозиторий отличается от локального тем, что кроме исходного кода содержит файлы,\
+    специфичные для среды заказчика. Например: Dockerfile, предопределенные файлы конфигурации
+
+    Аргументы:
+        dev_repo_path - путь к локальному репозиторию разработчика, например "./"
+
+        release_repo_url - url удаленного репозитория
+
+        release_path - путь к локальной папке, в которой должен быть создан релиз, например "./.release"
+
+        release_dev_repo_path - путь к папке, в которой должна находится копия исходного кода
+        из локального репозитозитория резработчика, например "./release/src"
+        Путь, указанный в release_dev_repo_path, должен находится внути пути release_path
+
+        func_before_dev_repo_clone - функция, выполняющаяся перед копированием исходного кода
+        из локального репозитория разработчика в релиз.
+        Используется, например, для автообновления документации перед релизом
+
+        func_after_dev_repo_clone - функция, выполняющаяся после копирования исходного кода
+        из локального репозитория разработчика в релиз.
+        Используется, например, для добавления доп. артефактов в релиз
+    """
+
+    dev_repo_path = dev_repo_path.resolve()
+    release_path = release_path.resolve()
+    release_dev_repo_path = release_dev_repo_path.resolve()
+    release_safe_utils = ReleaseSafeUtils(release_path=release_path)
+    uv_path = shutil.which("uv")
+
+    ########################################
+    if release_path == dev_repo_path:
+        err_msg = f"Путь в аргументе release_path ({release_path}) не может совпадать с dev_repo_path ({dev_repo_path})"
+        raise Exception(err_msg)
+
+    if dev_repo_path.is_relative_to(release_path):
+        err_msg = f"Путь в аргументе dev_repo_path ({dev_repo_path}) не может быть внутри release_path ({release_path})"
+        raise Exception(err_msg)
+
+    if not release_path.is_relative_to(dev_repo_path):
+        err_msg = f"Путь в аргументе release_path ({release_path}) должен быть внутри dev_repo_path ({dev_repo_path})"
+        raise Exception(err_msg)
+
+    if not release_dev_repo_path.is_relative_to(release_path):
+        err_msg = (
+            f"Путь в аргументе release_dev_repo_path ({release_dev_repo_path})"
+            f" должен быть внутри release_path ({release_path})"
+        )
+        raise Exception(err_msg)
+
+    if not uv_path:
+        err_msg = "не найден uv"
+        raise Exception(err_msg)
+
+    ########################################
+    Path.mkdir(release_path, exist_ok=True)
+
+    if not (release_path / ".git").exists():
+        print(f"Клонирование удаленного репозитория {release_repo_url} (clone --depth=1 --no-single-branch)")
+        Repo.clone_from(release_repo_url, release_path, allow_unsafe_protocols=True, depth=1, no_single_branch=True)
+
+    ########################################
+    dev_repo = Repo(dev_repo_path)
+    release_repo = Repo(release_path)
+
+    print(f"Загрузка новых изменений и веток из удаленного репозитория {release_repo_url} (fetch --depth=1 )")
+    fetch_res = release_repo.remotes.origin.fetch(allow_unsafe_protocols=True, depth=1)
+    for fetch_info in fetch_res:
+        print(f"Загружена ветка {fetch_info.ref}")
+
+    if dev_repo.active_branch.name != release_repo.active_branch.name:
+        if dev_repo.active_branch.name in release_repo.remotes.origin.refs:
+            print(f"Переключение на удаленную ветку {dev_repo.active_branch}")
+            release_repo.git.switch(dev_repo.active_branch.name)
+            release_repo.active_branch.set_tracking_branch(
+                release_repo.remotes.origin.refs[dev_repo.active_branch.name]
+            )
+        elif dev_repo.active_branch.name in release_repo.heads:
+            print(f"Переключение на локальную ветку {dev_repo.active_branch}")
+            release_repo.git.switch(dev_repo.active_branch.name)
+        else:
+            print(f"Создание новой локальной ветки {dev_repo.active_branch}")
+            release_repo.git.switch("-c", dev_repo.active_branch.name)
+
+    if release_repo.active_branch.is_remote():
+        print(f"Вытягивание изменений из удаленного репозитория {release_repo_url} (pull --ff-only --depth 1)")
+        pull_res = release_repo.remotes.origin.pull(allow_unsafe_protocols=True, ff_only=True, depth=1)
+        for pull_info in pull_res:
+            print(f"Обновлена ветка {pull_info.ref}")
+
+    ########################################
+    print(f"Создание requirements.txt в {release_path}")
+    print(
+        subprocess.check_output(  # noqa S603
+            [
+                uv_path,
+                "export",
+                "--format",
+                "requirements.txt",
+                "-o",
+                release_path / "requirements.txt",
+                "--no-dev",
+                "--quiet",
+                "--frozen",
+                "--no-hashes",
+                "--no-editable",
+                "--no-emit-local",
+            ],
+            text=True,
+            cwd=Path.cwd(),
+        )
+    )
+
+    ########################################
+    if func_before_dev_repo_clone:
+        func_before_dev_repo_clone(release_safe_utils)
+    ########################################
+
+    print(f"Копирование файлов локального репозитория в {release_dev_repo_path}")
+    release_safe_utils.copy_repo_files_safe(dev_repo, release_dev_repo_path)
+
+    ########################################
+    if func_after_dev_repo_clone:
+        func_after_dev_repo_clone(release_safe_utils)
+    ########################################
+
+    return release_safe_utils

tooaio_scripts-1.0.0/src/openapi_doc.py

@@ -0,0 +1,12 @@
+from typing import Any
+from .openapi_to_pdf import build_pdf
+import json
+
+
+def openapi_to_json(openapi_dict: dict[str, Any], output_path: str) -> None:
+    with open(output_path, "w", encoding="utf-8") as f:
+        json.dump(openapi_dict, f, ensure_ascii=False, indent=2)
+
+
+def openapi_to_pdf(openapi_dict: dict[str, Any], output_path: str) -> None:
+    build_pdf(openapi_dict, output_path)