compose-generator 0.2.1__tar.gz → 0.3.0__tar.gz

{compose_generator-0.2.1 → compose_generator-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compose-generator
-Version: 0.2.1
+Version: 0.3.0
 Summary: Проект представляет собой генератор docker-compose.yml файла на основе настроек приложения
 Author: pasha_danilevich
 Author-email: danilevitch.pasha@yandex.ru

{compose_generator-0.2.1 → compose_generator-0.3.0}/README.md

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

{compose_generator-0.2.1 → compose_generator-0.3.0}/compose_generator/__init__.py

@@ -1,174 +1,228 @@
-from typing import Optional
-
-from pydantic_settings import BaseSettings
-
-ENV_KEY = '[ENV]'
-VERSION_KEY = '[VERSION]'
-
-class ConfigurationComponent:
-    """Конфигурационные объекты, составляющие настройки всего приложения"""
-    
-    def __init__(self, item: BaseSettings, ignore: Optional[list[str]] = None) -> None:
-        self.item = item
-        self.ignore = ignore if ignore else []
-        
-        self.env_prefix = item.model_config.get("env_prefix", "")
-        self.attrs = list(item.model_dump().keys())
-    
-    @property
-    def title(self) -> str:
-        class_name = self.item.__class__.__name__
-        return f'# {class_name}'
-    
-    def compose_parsed(self) -> str:
-        """
-        Парсит объект в строку для записи в docker-compose.yml
-
-        Пример:
-          # RabbitMQ
-          RABBITMQ_HOST: ${RABBITMQ_HOST}
-          RABBITMQ_USER: ${RABBITMQ_USER}
-          RABBITMQ_PASS: ${RABBITMQ_PASS}
-        """
-
-        result = [self.title]
-        
-        for attr in self.attrs:
-            full_attr = self.env_prefix + attr
-            if full_attr not in self.ignore:
-                line = f"{full_attr}: " + f"${{{full_attr}}}"
-                result.append(line)
-        
-        return "\n".join(result)
-    
-    def env_parsed(self) -> str:
-        """
-        Парсит объект в строку для записи в .env
-        
-        Пример:
-          # RabbitMQ
-          RABBITMQ_HOST=value
-          RABBITMQ_USER=value
-          RABBITMQ_PASS=value
-        """
-        result = [self.title]
-        
-        for attr in self.attrs:
-            full_attr = self.env_prefix + attr
-            if full_attr not in self.ignore:
-                line = f"{full_attr}=value"
-                result.append(line)
-            
-        return "\n".join(result)
-
-
-class DockerCompose:
-    def __init__(
-        self,
-        settings: list[BaseSettings],
-        template: str,
-        version: Optional[str] = None,
-        ignore: Optional[list[str]] = None,
-    ) -> None:
-        self.settings = settings
-        self.template = template
-        self.version = version
-        self.ignore = ignore
-    
-    def insert_to_template(self, content: str, key: str) -> None:
-        # TODO: делать Trilling Whitespace
-        # Разбиваем вставляемую строку на отдельные строки
-        
-        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: Optional[str] = None) -> None:
-        if version is not None:
-            self.template = self.template.replace(VERSION_KEY, version)
-    
-    def __call__(self, filename: str) -> None:
-        parsed_components: list[str] = [
-            ConfigurationComponent(c, self.ignore).compose_parsed() for c in self.settings
-        ]
-        
-        self.insert_to_template(
-            content='\n\n'.join(parsed_components), key=ENV_KEY
-        )
-        self.replace_version(self.version)
-        
-        with open(filename, 'w') as f:
-            f.write(self.template)
-
-
-class ExampleEnv:
-    def __init__(
-        self,
-        settings: list[BaseSettings],
-        ignore: Optional[list[str]] = None,
-    ) -> None:
-        self.settings = settings
-        self.ignore = ignore
-    
-    def __call__(self, filename: str) -> None:
-        parsed_components: list[str] = [
-            ConfigurationComponent(c, self.ignore).env_parsed() for c in self.settings
-        ]
-        text = '\n\n'.join(parsed_components)
-        with open(filename, 'w') as f:
-            f.write(text)
-
-class Generate:
-    def __init__(
-        self,
-        settings: list[BaseSettings],
-    ) -> None:
-        self.settings = settings
-    
-    def docker_compose(
-        self,
-        template: str,
-        version: Optional[str] = None,
-        ignore: Optional[list[str]] = None,
-        filename: str = 'docker-compose.yml'
-    ) -> None:
-        DockerCompose(
-            settings=self.settings,
-            template=template,
-            version=version,
-            ignore=ignore,
-        )(filename)
-    
-    def example_env(self,
-        ignore: Optional[list[str]] = None,
-        filename: str = '.env.example'
-        ) -> None:
-        ExampleEnv(
-            settings=self.settings,
-            ignore=ignore,
-        )(filename)
-
-
-class Generator:
-    """Генератор docker-compose.yml"""
-    
-    def __init__(
-        self,
-        settings: list[BaseSettings],
-    ) -> None:
-        self.settings = settings
-    
-    @property
-    def generate(self) -> Generate:
-        return Generate(settings=self.settings)
+from typing import Optional, Any
+
+from pydantic_settings import BaseSettings
+
+ENV_KEY = '[ENV]'
+VERSION_KEY = '[VERSION]'
+
+
+class ConfigurationComponent:
+    """Конфигурационный объект, составляющий настройки приложения."""
+
+    def __init__(
+        self,
+        item: BaseSettings,
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.item = item
+        self.ignore = ignore or []
+
+        self.env_prefix = item.model_config.get("env_prefix", "")
+
+        self.schema: dict[str, Any] = item.__class__.model_json_schema()
+        self.properties: dict[str, Any] = self.schema.get("properties", {})
+        self.required: set[str] = set(self.schema.get("required", []))
+
+        self.attrs = list(self.properties.keys())
+
+    @property
+    def title(self) -> str:
+        return f"# {self.item.__class__.__name__}"
+
+    @property
+    def max_attr_length(self) -> int:
+        return max(
+            (
+                len(self.env_prefix + attr)
+                for attr in self.attrs
+                if self.env_prefix + attr not in self.ignore
+            ),
+            default=0,
+        )
+    
+    def compose_parsed(self, max_length: int = 0) -> str:
+        """
+        Генерирует переменные для docker-compose.yml.
+        Обязательные поля получают проверку на пустое значение.
+        Имена переменных выравниваются по общей максимальной длине.
+        """
+        result = [self.title]
+        
+        for attr in self.attrs:
+            full_attr = self.env_prefix + attr
+            
+            if full_attr in self.ignore:
+                continue
+            
+            name = f"{full_attr}:".ljust(max_length + 1)
+            
+            if attr in self.required:
+                value = f"${{{full_attr}:?{full_attr} is required}}"
+            else:
+                value = f"${{{full_attr}}}"
+            
+            result.append(f"{name} {value}")
+        
+        return "\n".join(result)
+
+    def get_type_string(self, attr: str) -> str:
+        """Возвращает тип атрибута из JSON Schema."""
+        property_schema = self.properties.get(attr, {})
+
+        if "type" in property_schema:
+            return property_schema["type"]
+
+        any_of = property_schema.get("anyOf")
+
+        if any_of:
+            types = [
+                item["type"]
+                for item in any_of
+                if "type" in item
+            ]
+            return "|".join(types)
+
+        return "unknown"
+
+    def env_parsed(self) -> str:
+        """Генерирует переменные для .env.example."""
+        result = [self.title]
+
+        for attr in self.attrs:
+            full_attr = self.env_prefix + attr
+
+            if full_attr in self.ignore:
+                continue
+
+            line = f"{full_attr}={self.get_type_string(attr)}"
+            result.append(line)
+
+        return "\n".join(result)
+
+
+class DockerCompose:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+        template: str,
+        version: Optional[str] = None,
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.settings = settings
+        self.template = template
+        self.version = version
+        self.ignore = ignore
+    
+    def insert_to_template(self, content: str, key: str) -> None:
+        # TODO: делать Trilling Whitespace
+        # Разбиваем вставляемую строку на отдельные строки
+        
+        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: Optional[str] = None) -> None:
+        if version is not None:
+            self.template = self.template.replace(VERSION_KEY, version)
+    
+    @property
+    def max_attr_length(self) -> int:
+        return max(
+            (
+                ConfigurationComponent(c, self.ignore).max_attr_length
+                for c in self.settings
+            ),
+            default=0,
+        )
+    
+    def __call__(self, filename: str) -> None:
+        max_length = self.max_attr_length
+        
+        parsed_components: list[str] = [
+            ConfigurationComponent(c, self.ignore).compose_parsed(max_length)
+            for c in self.settings
+        ]
+        
+        self.insert_to_template(
+            content='\n\n'.join(parsed_components),
+            key=ENV_KEY,
+        )
+        
+        self.replace_version(self.version)
+        
+        with open(filename, 'w') as f:
+            f.write(self.template)
+
+
+class ExampleEnv:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.settings = settings
+        self.ignore = ignore
+    
+    def __call__(self, filename: str) -> None:
+        parsed_components: list[str] = [
+            ConfigurationComponent(c, self.ignore).env_parsed() for c in self.settings
+        ]
+        text = '\n\n'.join(parsed_components)
+        with open(filename, 'w') as f:
+            f.write(text)
+
+
+class Generate:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+    ) -> None:
+        self.settings = settings
+    
+    def docker_compose(
+        self,
+        template: str,
+        version: Optional[str] = None,
+        ignore: Optional[list[str]] = None,
+        filename: str = 'docker-compose.yml'
+    ) -> None:
+        DockerCompose(
+            settings=self.settings,
+            template=template,
+            version=version,
+            ignore=ignore,
+        )(filename)
+    
+    def example_env(self,
+                    ignore: Optional[list[str]] = None,
+                    filename: str = '.env.example'
+                    ) -> None:
+        ExampleEnv(
+            settings=self.settings,
+            ignore=ignore,
+        )(filename)
+
+
+class Generator:
+    """Генератор docker-compose.yml"""
+    
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+    ) -> None:
+        self.settings = settings
+    
+    @property
+    def generate(self) -> Generate:
+        return Generate(settings=self.settings)

{compose_generator-0.2.1 → compose_generator-0.3.0}/compose_generator/example.env

@@ -1,16 +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
-
+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.2.1 → compose_generator-0.3.0}/compose_generator/example.py

@@ -1,102 +1,104 @@
-# Example
-from compose_generator import Generator
-
-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)
-
-
-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
-"""
-
-if __name__ == "__main__":
-    stt = Settings()
-    generator = Generator(
-        settings=list(stt.__dict__.values()),
-    )
-    generator.generate.docker_compose(
-        template=TEMPLATE,
-    )
+# Example
+from compose_generator import Generator
+
+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)
+
+
+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
+"""
+
+if __name__ == "__main__":
+    stt = Settings()
+    generator = Generator(
+        settings=list(stt.__dict__.values()),
+    )
+    generator.generate.docker_compose(
+        template=TEMPLATE,
+        version=stt.app.VERSION,
+        ignore=['APP_VERSION'],
+    )
     generator.generate.example_env()

{compose_generator-0.2.1 → compose_generator-0.3.0}/pyproject.toml

@@ -1,16 +1,16 @@
-[project]
-name = "compose-generator"
-version = "0.2.1"
-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"
+[project]
+name = "compose-generator"
+version = "0.3.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"

compose_generator-0.2.1/compose_generator/.env.example

@@ -1,21 +0,0 @@
-# App
-APP_SERVER_PORT=value
-APP_VERSION=value
-
-# DefaultDB
-DEFAULT_DB_USER=value
-DEFAULT_DB_PASS=value
-DEFAULT_DB_HOST=value
-DEFAULT_DB_PORT=value
-DEFAULT_DB_NAME=value
-
-# JWT
-JWT_SECRET_KEY=value
-JWT_EXPIRES_SECONDS=value
-
-# API
-API_KEY=value
-
-# Swagger
-SWAGGER_LOGIN=value
-SWAGGER_PASSWORD=value

compose_generator-0.2.1/compose_generator/docker-compose.yml

@@ -1,40 +0,0 @@
-version: "3.9"
-
-networks:
-  common-net:
-    external: true
-
-x-serv-common-env: &serv-common-env
-  # App
-  APP_SERVER_PORT: ${APP_SERVER_PORT}
-  APP_VERSION: ${APP_VERSION}
-  
-  # DefaultDB
-  DEFAULT_DB_USER: ${DEFAULT_DB_USER}
-  DEFAULT_DB_PASS: ${DEFAULT_DB_PASS}
-  DEFAULT_DB_HOST: ${DEFAULT_DB_HOST}
-  DEFAULT_DB_PORT: ${DEFAULT_DB_PORT}
-  DEFAULT_DB_NAME: ${DEFAULT_DB_NAME}
-  
-  # JWT
-  JWT_SECRET_KEY: ${JWT_SECRET_KEY}
-  JWT_EXPIRES_SECONDS: ${JWT_EXPIRES_SECONDS}
-  
-  # API
-  API_KEY: ${API_KEY}
-  
-  # Swagger
-  SWAGGER_LOGIN: ${SWAGGER_LOGIN}
-  SWAGGER_PASSWORD: ${SWAGGER_PASSWORD}
-
-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