codex-core 0.1.0__tar.gz

codex_core-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches: [ main, develop ]
+    paths-ignore: [ '**.md', 'docs/**', '.gitignore' ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  quality-gate:
+    name: Quality Gate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: 'pip'
+
+      - name: Install Dev Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Pre-commit (Ruff, Format, Bandit, Secrets)
+        uses: pre-commit/action@v3.0.1
+
+      - name: Run pip-audit
+        run: pip install pip-audit && pip-audit
+
+      - name: Run Mypy
+        run: pip install mypy && mypy src/codex_core/
+
+  unit-tests:
+    name: Unit Tests
+    needs: quality-gate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: 'pip'
+
+      - name: Install All Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run Unit Tests
+        run: pytest tests/ -m "unit" -v --tb=short

codex_core-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'src/**'
+      - 'pyproject.toml'
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Build & Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Build and Deploy Docs
+        run: mkdocs gh-deploy --force

codex_core-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/codex-core/
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: 'pip'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine hatchling
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check artifacts
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true

codex_core-0.1.0/.gitignore

@@ -0,0 +1,200 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm / JetBrains
+.idea/
+*.iws
+out/
+gen/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

codex_core-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-json
+      - id: check-added-large-files
+        args: ['--maxkb=2000']
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
+    hooks:
+      - id: markdownlint
+        args: ["--fix", "--disable", "MD013"]
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.2
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml"]
+        additional_dependencies: ["bandit[toml]"]
+
+  # 2. Поиск "забытых" секретов и паролей (усиленный)
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        # Baseline will be added after manual creation

codex_core-0.1.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-05-24
+
+### Added
+- **Project Structure**: Initial setup of the core library as a standalone project.
+- **Advanced PII Protection**:
+  - Implementation of `BaseDTO` with automated, recursive PII masking in `repr` and `str`.
+  - Keyword-based sensitive data detection (phone, email, name, address, notes).
+- **International Utilities**:
+  - `normalize_phone`: Robust normalization supporting `+`, `00`, and local German `0` formats.
+  - `normalize_name`: Smart capitalization preserving hyphens and spaces.
+  - `TaskLogContext`: Structured logging adapter for background tasks and operations.
+- **Base Settings**: `BaseCommonSettings` with standardized Redis URL generation and environment-aware flags.
+- **Documentation**:
+  - New Domain-Driven documentation standard (Architecture + API Reference).
+  - Bilingual support (EN/RU) with structural mirroring.
+- **Testing**:
+  - Comprehensive unit test suite (27 scenarios) covering Core, Common, and Settings.
+  - Integration test for environment variable loading.
+
+### Changed
+- **Package Rename**: Renamed package from `codex_tools` to `codex_core` for better clarity.
+- **Dependency Optimization**:
+  - `loguru` removed from mandatory dependencies.
+  - `loguru_setup` updated with safe imports and clear installation instructions.
+- **CI/CD**:
+  - Switched GitHub Actions to use Node.js 24 (via `FORCE_JAVASCRIPT_ACTIONS_TO_NODE24`).
+  - Updated Mypy paths to reflect the new package structure.
+
+### Security
+- Integrated `bandit`, `pip-audit`, and `detect-secrets` into the development lifecycle.
+- Standardized `quote_plus` usage for all infrastructure connection strings.

codex_core-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: codex-core
+Version: 0.1.0
+Summary: Core utilities, schemas and settings for Codex WaaS toolkit
+Project-URL: Homepage, https://github.com/codexdlc/codex-core
+Project-URL: Documentation, https://codexdlc.github.io/codex-core/
+Project-URL: Repository, https://github.com/codexdlc/codex-core
+Project-URL: Changelog, https://github.com/codexdlc/codex-core/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/codexdlc/codex-core/issues
+Author: CodexDLC
+License: Apache-2.0
+Keywords: core,pydantic,toolkit,waas
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic<3.0,>=2.0
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7; extra == 'dev'
+Requires-Dist: detect-secrets>=1.5; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pip-audit>=2.7; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-include-markdown-plugin; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.5; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# codex-core
+
+**Core utilities, schemas, and settings for the Codex WaaS toolkit.**
+
+This library provides the foundational building blocks used by all other Codex tools. It focuses on Pydantic-based data models, structured logging, and configuration management.
+
+## 🚀 Key Features
+
+*   **Core Interfaces**: Base classes and protocols for Codex components.
+*   **Common Utilities**: Logger setup (Loguru), phone number validation, text processing, and caching.
+*   **Schemas**: Shared Pydantic models for cross-service communication.
+*   **Settings**: Modern configuration management using `pydantic-settings`.
+
+## 📦 Installation
+
+```bash
+pip install codex-core
+```
+
+## 🛠️ Quick Start
+
+```python
+from codex_tools.common.logger import setup_logger
+
+logger = setup_logger("my-app")
+logger.info("Codex Core is ready!")
+```
+
+---
+*Part of the [Codex WaaS](https://github.com/codexdlc) ecosystem.*

codex_core-0.1.0/README.md

@@ -0,0 +1,30 @@
+# codex-core
+
+**Core utilities, schemas, and settings for the Codex WaaS toolkit.**
+
+This library provides the foundational building blocks used by all other Codex tools. It focuses on Pydantic-based data models, structured logging, and configuration management.
+
+## 🚀 Key Features
+
+*   **Core Interfaces**: Base classes and protocols for Codex components.
+*   **Common Utilities**: Logger setup (Loguru), phone number validation, text processing, and caching.
+*   **Schemas**: Shared Pydantic models for cross-service communication.
+*   **Settings**: Modern configuration management using `pydantic-settings`.
+
+## 📦 Installation
+
+```bash
+pip install codex-core
+```
+
+## 🛠️ Quick Start
+
+```python
+from codex_tools.common.logger import setup_logger
+
+logger = setup_logger("my-app")
+logger.info("Codex Core is ready!")
+```
+
+---
+*Part of the [Codex WaaS](https://github.com/codexdlc) ecosystem.*

codex_core-0.1.0/docs/api/common.md

@@ -0,0 +1,21 @@
+[🏠 Home](../index.md) | [⚙️ API Reference](index.md) | [🛠️ Common API](common.md)
+
+# 🛠️ Common API (Utilities)
+
+This section describes the shared utility functions of the **codex-core** library.
+
+## Phone Normalization
+Tools for correctly formatting phone numbers (supports +, 00, and local 0).
+
+::: codex_core.common.phone
+
+## Text Processing
+Tools for name normalization, transliteration, and string cleaning.
+
+::: codex_core.common.text
+
+## Logging
+Helpers for structured logging and Loguru configuration.
+
+::: codex_core.common.log_context
+::: codex_core.common.loguru_setup

codex_core-0.1.0/docs/api/core.md

@@ -0,0 +1,15 @@
+[🏠 Home](../index.md) | [⚙️ API Reference](index.md) | [🛡️ Core API](core.md)
+
+# 🛡️ Core API (DTO & PII)
+
+This section describes the essential data models and security utilities of the **codex-core** library.
+
+## BaseDTO
+`BaseDTO` is an immutable Pydantic model with built-in PII masking for `repr` and `str`.
+
+::: codex_core.core.base_dto
+
+## PII Protection
+Utilities for identifying and masking sensitive data.
+
+::: codex_core.core.pii

codex_core-0.1.0/docs/api/index.md

@@ -0,0 +1,15 @@
+[🏠 Home](../index.md) | [🧭 Guide (EN)](../en_EN/README.md) | [⚙️ API Reference](index.md)
+
+# API Reference Overview
+
+Welcome to the **codex-core** API Reference! This section provides detailed information about all classes, functions, and modules in the library.
+
+## Core API (Essential)
+
+- **[🛡️ Core (DTO & PII)](core.md)**: Base data models and PII protection utilities.
+- **[🛠️ Common (Utilities)](common.md)**: Phone, text, and logging helpers.
+- **[⚙️ Settings (Config)](settings.md)**: Base configuration patterns.
+
+## Technical Details
+
+All files in this section use the `::: codex_core` directive to automatically extract documentation from source code docstrings.

codex_core-0.1.0/docs/api/settings.md

@@ -0,0 +1,10 @@
+[🏠 Home](../index.md) | [⚙️ API Reference](index.md) | [⚙️ Settings API](settings.md)
+
+# ⚙️ Settings API (Base Configuration)
+
+This section describes the base configuration patterns used across Codex projects.
+
+## BaseCommonSettings
+`BaseCommonSettings` is a Pydantic Settings model that handles Redis URLs and environment variable loading.
+
+::: codex_core.settings.base

codex_core-0.1.0/docs/changelog.md

@@ -0,0 +1 @@
+{% include "../CHANGELOG.md" %}

codex_core-0.1.0/docs/en_EN/README.md

@@ -0,0 +1,23 @@
+[🏠 Home](../index.md) | [🧭 Guide (EN)](README.md) | [⚙️ API Reference](../api/index.md)
+
+# Guide: Overview (EN)
+
+Welcome to the **codex-core** guide! This library serves as the shared foundation for all Codex projects, ensuring that essential utilities and architectural patterns remain consistent and maintainable.
+
+## Documentation Sections
+
+### 1. [Getting Started](guide/getting_started.md)
+How to install and integrate `codex-core` into your project.
+
+### 2. [🛡️ Architecture & Platform](architecture/README.md)
+Detailed breakdown of the core platform components:
+
+- **Core (DTO & PII)**: How data is structured and protected.
+- **Common Utilities**: Phone, text, and logging helpers.
+- **Settings Architecture**: How to manage configuration for different environments.
+
+### 3. [🗺 Evolution](../evolution/roadmap.md)
+Our core purpose and development philosophy.
+
+### 4. [⚙️ API Reference](../api/index.md)
+Technical details for developers.

codex_core-0.1.0/docs/en_EN/architecture/README.md

@@ -0,0 +1,25 @@
+[🏠 Home](../../index.md) | [🧭 Guide (EN)](../README.md) | [🛡️ Architecture](../../api/index.md)
+
+# 🛡️ Architecture & Platform Overview (EN)
+
+This section provides a high-level overview of the architectural patterns and foundational components provided by the **codex-core** library.
+
+## Domain Structure
+We divide the platform into three main domains, each serving a specific purpose:
+
+| Domain | Description | Key Components |
+| :--- | :--- | :--- |
+| **[🛡️ Core](platform/core.md)** | Essential data models and security. | `BaseDTO`, PII Masking, `mask_value`. |
+| **[🛠️ Common](platform/common.md)** | Standardized utility functions. | `normalize_phone`, `normalize_name`, `TaskLogContext`. |
+| **[⚙️ Settings](platform/settings.md)** | Infrastructure configuration. | `BaseCommonSettings`, `redis_url`. |
+
+## Core Principles
+1. **Security First**: PII protection is integrated at the base DTO level.
+2. **Immutability**: Data models are frozen by default to prevent side effects.
+3. **Standardization**: Common tasks (phone, name, logging) are solved once for all Codex projects.
+4. **Developer Friendly**: Comprehensive documentation and type hinting ensure a smooth experience.
+
+## Next Steps
+- Read about [🛡️ Core: PII & DTO](platform/core.md).
+- Explore [🛠️ Common Utilities](platform/common.md).
+- Understand [⚙️ Settings Architecture](platform/settings.md).

codex_core-0.1.0/docs/en_EN/architecture/platform/common.md

@@ -0,0 +1,40 @@
+[🏠 Home](../../../index.md) | [🧭 Guide (EN)](../../README.md) | [🛠️ Common API](../../../api/common.md)
+
+# 🛠️ Common: Utilities (Architecture)
+
+This section describes the shared utility functions that facilitate common tasks within the **codex-core** ecosystem.
+
+## Domain Goal
+The `common` domain provides a collection of robust, standardized, and framework-agnostic utilities to reduce boilerplate and prevent errors across multiple projects.
+
+## 1. Phone Normalization
+Standardized phone number formatting is essential for communication and consistency.
+
+### Features:
+- **International Support**: Handles `+49`, `0049`, and other international prefixes correctly.
+- **Local Formats**: Automatically converts local German numbers (starting with `0`) to the international `49` format.
+- **Robust Cleaning**: Removes non-digit characters while preserving important structure.
+
+```python
+from codex_core.common.phone import normalize_phone
+
+# Output: "491511234567"
+normalize_phone("0151 1234567")
+normalize_phone("+49 151 1234567")
+```
+
+## 2. Name Normalization
+A utility for correctly formatting first and last names, ensuring consistency in databases and communications.
+
+### Key Logic:
+- **Case Correction**: Automatically capitalizes names correctly (e.g., `ivan` -> `Ivan`).
+- **Compound Names**: Correctly handles hyphenated and space-separated names (e.g., `ivanov-petrov` -> `Ivanov-Petrov`).
+- **Space Management**: Removes extra spaces while preserving necessary separators.
+
+## 3. Structured Logging
+The `TaskLogContext` helper simplifies logging for structured background operations and tasks.
+
+### Advantages:
+- **Automatic Fields**: Adds `task` and `context` names to every log record.
+- **Compatibility**: Works seamlessly with standard `logging` and third-party tools like `loguru` and ELK.
+- **Traceability**: Makes it easy to filter logs by task or context in your log management system.