compose-generator 0.1.0__tar.gz

compose_generator-0.1.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: compose-generator
+Version: 0.1.0
+Summary: Проект представляет собой генератор docker-compose.yml файла на основе настроек приложения
+Author: pasha_danilevich
+Author-email: danilevitch.pasha@yandex.ru
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pydantic-settings (>=2.11.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+Этот проект представляет собой **генератор docker-compose.yml файла** на основе настроек приложения. Вот подробное описание:
+
+## Основное назначение
+Автоматическое создание `docker-compose.yml` файла с подстановкой всех переменных окружения из конфигурации приложения.
+
+## Ключевые компоненты
+
+### 1. `ConfigurationComponent`
+- **Назначение**: Преобразует объекты конфигурации в строки переменных окружения
+- **Функциональность**:
+  - Извлекает префикс переменных окружения из конфигурации Pydantic
+  - Генерирует строки в формате `VARIABLE_NAME: ${VARIABLE_NAME}`
+  - Добавляет комментарии с названиями классов конфигурации
+
+### 2. `Generator`
+- **Назначение**: Основной класс для генерации docker-compose файла
+- **Функциональность**:
+  - Заменяет плейсхолдеры `[ENV]` и `[VERSION]` в шаблоне
+  - Сохраняет форматирование и отступы
+  - Записывает результат в файл `docker-compose.yml`
+
+## Особенности реализации
+
+### Шаблон Docker Compose
+Создает сервисы:
+- **api** - веб-сервер с пробросом портов
+- **bg** - фоновый сервис
+- Оба используют общую сеть `common-net`
+
+### Автоматизация конфигурации
+- Извлекает все переменные из объектов `BaseSettings`
+- Сохраняет структуру и префиксы конфигурации
+- Генерирует полный список переменных окружения
+
+### Преимущества подхода
+1. **Синхронизация** - версии и настройки всегда актуальны
+2. **Безопасность** - не хранит чувствительные данные в репозитории
+3. **Автоматизация** - исключает ручное редактирование
+4. **Масштабируемость** - легко добавлять новые сервисы и настройки
+
+
+Проект полезен для CI/CD процессов, где требуется автоматическое создание docker-compose файлов с актуальными настройками окружения.

compose_generator-0.1.0/README.md

@@ -0,0 +1,42 @@
+Этот проект представляет собой **генератор docker-compose.yml файла** на основе настроек приложения. Вот подробное описание:
+
+## Основное назначение
+Автоматическое создание `docker-compose.yml` файла с подстановкой всех переменных окружения из конфигурации приложения.
+
+## Ключевые компоненты
+
+### 1. `ConfigurationComponent`
+- **Назначение**: Преобразует объекты конфигурации в строки переменных окружения
+- **Функциональность**:
+  - Извлекает префикс переменных окружения из конфигурации Pydantic
+  - Генерирует строки в формате `VARIABLE_NAME: ${VARIABLE_NAME}`
+  - Добавляет комментарии с названиями классов конфигурации
+
+### 2. `Generator`
+- **Назначение**: Основной класс для генерации docker-compose файла
+- **Функциональность**:
+  - Заменяет плейсхолдеры `[ENV]` и `[VERSION]` в шаблоне
+  - Сохраняет форматирование и отступы
+  - Записывает результат в файл `docker-compose.yml`
+
+## Особенности реализации
+
+### Шаблон Docker Compose
+Создает сервисы:
+- **api** - веб-сервер с пробросом портов
+- **bg** - фоновый сервис
+- Оба используют общую сеть `common-net`
+
+### Автоматизация конфигурации
+- Извлекает все переменные из объектов `BaseSettings`
+- Сохраняет структуру и префиксы конфигурации
+- Генерирует полный список переменных окружения
+
+### Преимущества подхода
+1. **Синхронизация** - версии и настройки всегда актуальны
+2. **Безопасность** - не хранит чувствительные данные в репозитории
+3. **Автоматизация** - исключает ручное редактирование
+4. **Масштабируемость** - легко добавлять новые сервисы и настройки
+
+
+Проект полезен для CI/CD процессов, где требуется автоматическое создание docker-compose файлов с актуальными настройками окружения.

compose_generator-0.1.0/compose_generator/__init__.py

@@ -0,0 +1,81 @@
+from pydantic_settings import BaseSettings
+
+
+class ConfigurationComponent:
+    """Конфигурационные объекты, составляющие настройки всего приложения"""
+
+    def __init__(self, item: BaseSettings) -> None:
+        self.item = item
+
+        self.env_prefix = item.model_config.get("env_prefix", "")
+        self.title = self.item.__class__.__name__
+        self.attrs = list(item.model_dump().keys())
+
+    def parsed(self) -> str:
+        """
+        Парсит объект в строку для записи в docker-compose.yml
+
+        Пример:
+          # RabbitMQ
+          RABBITMQ_HOST: ${RABBITMQ_HOST}
+          RABBITMQ_USER: ${RABBITMQ_USER}
+          RABBITMQ_PASS: ${RABBITMQ_PASS}
+        """
+        title = f'# {self.title}' if self.title else " "
+        result = [title]
+
+        for attr in self.attrs:
+            full_attr = self.env_prefix + attr
+            line = f"{full_attr}: " + f"${{{full_attr}}}"
+            result.append(line)
+
+        return "\n".join(result)
+
+
+class Generator:
+    """Генератор docker-compose.yml"""
+
+    ENV_KEY = '[ENV]'
+    VERSION_KEY = '[VERSION]'
+    FILE_NAME = 'docker-compose.yml'
+
+    def __init__(self, settings: BaseSettings, template: str, version: str) -> None:
+        self.settings = settings
+        self.template = template
+        self.version = version
+
+    def insert_to_template(self, content: str, key: str) -> None:
+        # Разбиваем вставляемую строку на отдельные строки
+
+        def define_indentation() -> str:
+            lines = self.template.split('\n')
+            for line in lines:
+                if key in line:
+                    return line.split(key)[0]
+            return ''
+
+        # Форматируем каждую строку с правильным отступом
+        formatted = '\n'.join(
+            [define_indentation() + line for line in content.split('\n')]
+        )
+
+        # Заменяем {ENV} в шаблоне
+        self.template = self.template.replace(key, formatted.strip())
+
+    def replace_version(self, version: str) -> None:
+        self.template = self.template.replace(self.VERSION_KEY, version)
+
+    def generate(self) -> None:
+        components = list(self.settings.__dict__.values())
+        parsed_components: list[str] = [
+            ConfigurationComponent(c).parsed() for c in components
+        ]
+
+        self.insert_to_template(
+            content='\n\n'.join(parsed_components), key=self.ENV_KEY
+        )
+        self.replace_version(self.version)
+
+        with open(self.FILE_NAME, 'w') as f:
+            f.write(self.template)
+

compose_generator-0.1.0/compose_generator/example.env

@@ -0,0 +1,16 @@
+APP_SERVER_PORT=5000
+
+DEFAULT_DB_USER=test
+DEFAULT_DB_PASS=test
+DEFAULT_DB_HOST=test
+DEFAULT_DB_PORT=123
+DEFAULT_DB_NAME=test
+
+JWT_EXPIRES_SECONDS=259200
+JWT_SECRET_KEY=ls6ied8kQ2jd
+
+API_KEY=ls6ied8sdaf4wkQ2jd
+
+SWAGGER_LOGIN=admin
+SWAGGER_PASSWORD=admin
+

compose_generator-0.1.0/compose_generator/example.py

@@ -0,0 +1,101 @@
+# Example
+from compose_generator import Generator
+
+TEMPLATE = """version: "3.9"
+
+networks:
+  common-net:
+    external: true
+
+x-serv-common-env: &serv-common-env
+  [ENV]
+
+services:
+  api:
+    image: /project/user/super-project/api:[VERSION]
+    networks:
+      - common-net
+    ports:
+      - ${APP_SERVER_PORT}:${APP_SERVER_PORT}
+    environment:
+      <<: *serv-common-env
+    restart:
+      unless-stopped
+"""
+
+from pathlib import Path
+
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class FromEnvFile(BaseSettings):
+    model_config = SettingsConfigDict(
+        env_file=Path(Path(__file__).resolve().parent, "example.env"),
+        extra="ignore",
+    )
+
+
+class BaseConnection(FromEnvFile):
+    USER: str
+    PASS: str
+    HOST: str
+    PORT: int
+    NAME: str
+
+    def get_connection_config(self) -> dict:
+        return {
+            "engine": "tortoise.backends.asyncpg",
+            "credentials": {
+                "host": self.HOST,
+                "port": self.PORT,
+                "user": self.USER,
+                "password": self.PASS,
+                "database": self.NAME,
+            },
+        }
+
+
+class DefaultDB(BaseConnection):
+    model_config = SettingsConfigDict(env_prefix="DEFAULT_DB_")
+
+
+class App(FromEnvFile):
+    model_config = SettingsConfigDict(env_prefix="APP_")
+    SERVER_PORT: int
+    VERSION: str = '1.0.0'
+
+
+class API(FromEnvFile):
+    model_config = SettingsConfigDict(env_prefix="API_")
+    KEY: str
+
+
+class Swagger(FromEnvFile):
+    model_config = SettingsConfigDict(env_prefix="SWAGGER_")
+    LOGIN: str
+    PASSWORD: str
+
+
+class JWT(FromEnvFile):
+    model_config = SettingsConfigDict(env_prefix="JWT_")
+    SECRET_KEY: str
+    EXPIRES_SECONDS: int
+
+
+class Settings(BaseSettings):
+    app: App = Field(default_factory=App)
+    db: DefaultDB = Field(default_factory=DefaultDB)
+    jwt: JWT = Field(default_factory=JWT)
+    api: API = Field(default_factory=API)
+    swagger: Swagger = Field(default_factory=Swagger)
+
+
+if __name__ == "__main__":
+    stt = Settings()
+    generator = Generator(
+        settings=stt,
+        template=TEMPLATE,
+        version=stt.app.VERSION,
+    )
+    generator.generate()

compose_generator-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "compose-generator"
+version = "0.1.0"
+description = "Проект представляет собой генератор docker-compose.yml файла на основе настроек приложения"
+authors = [
+    {name = "pasha_danilevich",email = "danilevitch.pasha@yandex.ru"}
+]
+readme = "README.md"
+requires-python = ">=3.10"
+
+[tool.poetry.dependencies]
+pydantic-settings = "^2.11.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"