Skip to content

🏠 На главную | 🧭 Руководство (RU) | 🚀 Начало работы

Начало работы (RU)

Добро пожаловать! Это руководство поможет вам быстро и правильно интегрировать codex-core в ваш проект.

Установка

Установите библиотеку с помощью pip:

pip install codex-core

Установка из исходного кода

Если вам нужны самые свежие изменения из ветки main, вы можете установить её напрямую из репозитория:

pip install git+https://github.com/codexdlc/codex-core.git

Опциональные зависимости

Если вы хотите использовать преднастроенный логгер Loguru, вам нужно будет установить loguru вручную:

pip install loguru

Первые шаги

1. Создание BaseDTO

Наследуйтесь от BaseDTO, чтобы получить автоматическую маскировку PII в ваших логах:

from codex_core.core import BaseDTO

class UserDTO(BaseDTO):
    full_name: str
    email: str
    phone: str

2. Настройка конфигурации

Используйте BaseCommonSettings для стандартизированной загрузки переменных окружения:

from codex_core.settings import BaseCommonSettings

class ProjectSettings(BaseCommonSettings):
    my_api_key: str = "secret"

Что дальше?

Ознакомьтесь с 🛡️ Обзором архитектуры для более подробной информации.