chutils 2.8.0__tar.gz → 3.0.0__tar.gz

chutils-3.0.0/.gitattributes

@@ -0,0 +1,2 @@
+poetry.lock binary
+uv.lock binary

chutils-3.0.0/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test-and-lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras
+
+      - name: Run Tests
+        run: |
+          uv run pytest
+
+      - name: Run Type Checking (Mypy)
+        run: |
+          uv run mypy src
+
+      - name: Run AI-Readiness Audit
+        run: |
+          uv run python -m chutils dev ai-lint --soft-mode
+

chutils-3.0.0/.github/workflows/publish-docs.yml

@@ -0,0 +1,34 @@
+name: Publish Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force --clean

chutils-3.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,125 @@
+[Русская версия](docs/CODE_OF_CONDUCT_RU.md)
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+*   Demonstrating empathy and kindness toward other people
+*   Being respectful of differing opinions, viewpoints, and experiences
+*   Giving and gracefully accepting constructive feedback
+*   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+*   Focusing on what is best not just for us as individuals, but for the
+    overall community
+
+Examples of unacceptable behavior include:
+
+*   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind
+*   Trolling, insulting or derogatory comments, and personal or political
+    attacks
+*   Public or private harassment
+*   Publishing others' private information, such as a physical or email
+    address, without their explicit permission
+*   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for
+moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`sergeiivanov636@gmail.com`.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

chutils-3.0.0/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+[Русская версия](docs/CONTRIBUTING_RU.md)
+
+# How to Contribute to chutils
+
+We're excited that you want to help improve the project! Every contribution is highly valued.
+
+This document provides a set of guidelines for contributing to `chutils`.
+
+## Code of Conduct
+
+First and foremost, please review our [Code of Conduct](./CODE_OF_CONDUCT.md). We expect all participants to adhere to it.
+
+## How Can You Help?
+
+### Reporting Bugs
+
+- Ensure the bug hasn't already been reported by checking the [Issues](https://github.com/Chu4hel/chutils/issues) section.
+- If you don't find a similar issue, create a new one. Be sure to include a clear title, a detailed description, and, if possible, a small code sample to reproduce the error.
+
+### Suggesting Enhancements
+
+- Create a new issue with your suggestion. Describe in detail the problem your enhancement solves and how it should work.
+
+### Pull Requests
+
+We welcome your pull requests! Here’s how to do it right:
+
+1.  Fork the repository.
+2.  Create a new branch for your changes (`git checkout -b feature/amazing-feature`).
+3.  Make your changes and write tests for them if necessary.
+4.  Ensure all tests pass.
+5.  Submit a pull request to the `main` branch of our repository.
+
+## Development Environment Setup
+
+1.  Clone your forked repository:
+    ```bash
+    git clone https://github.com/YOUR_USERNAME/chutils.git
+    ```
+
+2.  Navigate to the project directory:
+    ```bash
+    cd chutils
+    ```
+
+3.  Install dependencies using Poetry:
+    ```bash
+    poetry install
+    ```
+
+## Testing and Documentation
+
+- **Run tests**:
+  ```bash
+  poetry run pytest
+  ```
+
+- **View documentation locally**:
+  ```bash
+  poetry run mkdocs serve
+  ```
+
+## Code and Commit Style
+
+- **Code Style**: We adhere to the PEP 8 standard. Please ensure your code complies with it.
+- **Docstrings**: All docstrings are written in **Google style**. Please follow this convention.
+- **Commits**: We use [Conventional Commits](https://www.conventionalcommits.org/). This helps us maintain a clean and understandable change history.
+  *Example: `feat(config): add support for .toml format` or `fix(logger): correct log rotation error`*
+
+Thank you for your contribution!

chutils-3.0.0/GEMINI.md

@@ -0,0 +1,49 @@
+# chutils: Project Identity & Conventions
+
+Этот файл содержит глобальные инструкции для AI-агентов (Gemini CLI и др.) по работе с кодовой базой проекта `chutils`.
+
+## 1. Архитектура и структура
+
+Проект построен по модульному принципу с ленивой загрузкой в корневом `__init__.py`.
+
+- **src/chutils/config/**: Ядро управления конфигурацией (Hot-Reload, многоуровневое слияние).
+- **src/chutils/logger/**: Продвинутый логгер на базе `rich` с поддержкой маскировки секретов.
+- **src/chutils/secret_manager/**: Абстракция над системными хранилищами (keyring) и облачными провайдерами.
+- **src/chutils/commands/**: Реализации CLI команд (argparse).
+
+## 2. Кодирование и Conventions (Rules)
+
+- **Публичное API**: Почти всё публичное API экспортируется через `src/chutils/__init__.py`. При использовании
+  библиотеки извне, импортируйте напрямую из `chutils`.
+- **Lazy Loading**: Библиотека активно использует ленивую загрузку (PEP 562). Избегайте прямых импортов из глубоких
+  подмодулей, если это не обосновано внутренней реализацией.
+- **Опциональные зависимости (Безопасный экспорт)**: При импорте сторонних библиотек (особенно опциональных),
+  экспортируемый символ ОБЯЗАТЕЛЬНО должен быть определен в модуле, даже если его функционал зависит от отсутствующей
+  библиотеки (например, `Feature = None`). Это предотвращает каскадные `ImportError`.
+- **Rich Integration**: При выводе в консоль всегда используйте `chutils.cli_utils.get_console()`. Это гарантирует
+  корректный fallback, если `rich` не установлен.
+- **Строгая типизация (Zero-Any Strategy)**:
+    - Запрещено использование `Any` в аннотациях типов бизнес-логики.
+    - Запрещено использование `# type: ignore` без крайне веского обоснования и комментария.
+    - **Исключение:** В инфраструктурных модулях и сложных декораторах (например, `chutils/decorators.py`,
+      `chutils/features.py`) **разрешается** использовать `Any` и `# type: ignore` вместо сложных конструкций
+      `ParamSpec`/`cast`, если строгая типизация приводит к нечитаемому коду. Читаемость важнее идеального отчета Mypy.
+- **Типизация Python 3.10+**:
+    - Запрещено импортировать и использовать устаревшие типы из модуля `typing`, такие как `Optional`, `List`, `Dict`,
+      `Tuple` и др.
+    - Вместо `Optional[T]` обязательно используйте `T | None`.
+    - Вместо `List[T]`, `Dict[K, V]`, `Tuple[T, ...]` используйте встроенные типы `list[T]`, `dict[K, V]`,
+      `tuple[T, ...]` без импорта из `typing`.
+- **Документация**: Подробные советы для AI находятся в `docs/ai_hints.md` и `docs/INTEGRATION_AI.md`.
+
+## 3. Тестирование
+
+- Используется `pytest` с `pytest-mock`.
+- Новая функциональность всегда должна сопровождаться тестами в `tests/unit/`.
+- Тесты CLI команд должны проверяться через `sys.argv` mocking и `capsys` для проверки вывода.
+
+## 4. Ссылки
+
+- [AI Hints](./docs/ai_hints.md)
+- [Integration Guide](./docs/INTEGRATION_AI.md)
+- [Public API Map](./api_map.md) (генерируется через `chutils dev generate-context -o api_map.md`)

{chutils-2.8.0 → chutils-3.0.0}/PKG-INFO

@@ -1,54 +1,62 @@
 Metadata-Version: 2.4
 Name: chutils
-Version: 2.8.0
+Version: 3.0.0
 Summary: Набор простых и удобных утилит для Python, который избавляет от рутины при работе с конфигурацией и логированием в новых проектах.
+Author-email: Chu4hel <sergeiivanov636@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
-Author: Chu4hel
-Author-email: sergeiivanov636@gmail.com
-Requires-Python: >=3.9, !=3.9.0, !=3.9.1
-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-Python: <3.15,>=3.10
+Requires-Dist: exceptiongroup>=1.2.2; python_version < '3.11'
+Requires-Dist: python-dotenv>=1.2.2
+Requires-Dist: pyyaml>=6.0.3
+Provides-Extra: captcha
+Requires-Dist: httpx>=0.27.0; extra == 'captcha'
+Provides-Extra: crypto
+Requires-Dist: cryptography>=42.0.0; extra == 'crypto'
 Provides-Extra: date
+Requires-Dist: python-dateutil>=2.9.0; extra == 'date'
 Provides-Extra: full
+Requires-Dist: cryptography>=42.0.0; extra == 'full'
+Requires-Dist: httpx>=0.27.0; extra == 'full'
+Requires-Dist: keyring>=25.7.0; extra == 'full'
+Requires-Dist: opentelemetry-api>=1.41.1; extra == 'full'
+Requires-Dist: opentelemetry-exporter-otlp>=1.41.1; extra == 'full'
+Requires-Dist: opentelemetry-sdk>=1.41.1; extra == 'full'
+Requires-Dist: playwright>=1.49.0; extra == 'full'
+Requires-Dist: prometheus-client<1.0.0,>=0.20.0; extra == 'full'
+Requires-Dist: pydantic>=2.13.4; extra == 'full'
+Requires-Dist: pytest>=9.0.3; extra == 'full'
+Requires-Dist: python-dateutil>=2.9.0; extra == 'full'
+Requires-Dist: python-json-logger>=3.2.1; extra == 'full'
+Requires-Dist: rapidfuzz>=3.9.0; extra == 'full'
+Requires-Dist: rich>=15.0.0; extra == 'full'
+Requires-Dist: selenium>=4.27.0; extra == 'full'
+Requires-Dist: watchdog>=6.0.0; extra == 'full'
 Provides-Extra: json
+Requires-Dist: python-json-logger>=3.2.1; extra == 'json'
+Provides-Extra: metrics
+Requires-Dist: prometheus-client<1.0.0,>=0.20.0; extra == 'metrics'
 Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.41.1; extra == 'otel'
+Requires-Dist: opentelemetry-exporter-otlp>=1.41.1; extra == 'otel'
+Requires-Dist: opentelemetry-sdk>=1.41.1; extra == 'otel'
 Provides-Extra: pydantic
+Requires-Dist: pydantic<3.0.0,>=2.13.4; extra == 'pydantic'
 Provides-Extra: rich
+Requires-Dist: rich>=15.0.0; extra == 'rich'
+Provides-Extra: scraping
+Requires-Dist: playwright>=1.49.0; extra == 'scraping'
+Requires-Dist: selenium>=4.27.0; extra == 'scraping'
 Provides-Extra: secrets
+Requires-Dist: keyring>=25.7.0; extra == 'secrets'
 Provides-Extra: testing
+Requires-Dist: pytest>=9.0.3; extra == 'testing'
+Provides-Extra: text
+Requires-Dist: rapidfuzz>=3.9.0; extra == 'text'
 Provides-Extra: watch
-Requires-Dist: keyring (>=25.7.0)
-Requires-Dist: keyring (>=25.7.0) ; extra == "full"
-Requires-Dist: keyring (>=25.7.0) ; extra == "secrets"
-Requires-Dist: opentelemetry-api (>=1.41.1) ; extra == "full"
-Requires-Dist: opentelemetry-api (>=1.41.1) ; extra == "otel"
-Requires-Dist: opentelemetry-exporter-otlp (>=1.41.1) ; extra == "full"
-Requires-Dist: opentelemetry-exporter-otlp (>=1.41.1) ; extra == "otel"
-Requires-Dist: opentelemetry-sdk (>=1.41.1) ; extra == "full"
-Requires-Dist: opentelemetry-sdk (>=1.41.1) ; extra == "otel"
-Requires-Dist: pydantic (>=2.13.4) ; extra == "full"
-Requires-Dist: pydantic (>=2.13.4,<3.0.0) ; extra == "pydantic"
-Requires-Dist: pytest (>=8.0.0) ; (python_full_version < "3.10.0") and (extra == "full")
-Requires-Dist: pytest (>=8.0.0) ; (python_full_version < "3.10.0") and (extra == "testing")
-Requires-Dist: pytest (>=9.0.3) ; (python_full_version >= "3.10.0") and (extra == "full")
-Requires-Dist: pytest (>=9.0.3) ; (python_full_version >= "3.10.0") and (extra == "testing")
-Requires-Dist: python-dateutil (>=2.9.0) ; extra == "date"
-Requires-Dist: python-dateutil (>=2.9.0) ; extra == "full"
-Requires-Dist: python-dotenv (>=1.2.1) ; python_full_version < "3.10.0"
-Requires-Dist: python-dotenv (>=1.2.2) ; python_full_version >= "3.10.0"
-Requires-Dist: python-json-logger (>=3.2.1) ; extra == "full"
-Requires-Dist: python-json-logger (>=3.2.1) ; extra == "json"
-Requires-Dist: pyyaml (>=6.0.3)
-Requires-Dist: rich (>=15.0.0) ; extra == "full"
-Requires-Dist: rich (>=15.0.0) ; extra == "rich"
-Requires-Dist: typing-extensions (>=4.15.0,<5.0.0)
-Requires-Dist: watchdog (>=6.0.0) ; extra == "full"
-Requires-Dist: watchdog (>=6.0.0) ; extra == "watch"
+Requires-Dist: watchdog>=6.0.0; extra == 'watch'
+Provides-Extra: web
+Requires-Dist: httpx>=0.27.0; extra == 'web'
 Description-Content-Type: text/markdown
 
 [Русская версия](docs/README_RU.md)
@@ -56,7 +64,7 @@ Description-Content-Type: text/markdown
 # chutils: Stop the Routine!
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
 [![PyPI version](https://badge.fury.io/py/chutils.svg)](https://badge.fury.io/py/chutils)
 [![Documentation](https://img.shields.io/badge/documentation-read-brightgreen)](https://Chu4hel.github.io/chutils/)
 
@@ -217,10 +225,10 @@ To use this feature, install `watchdog`:
 1. Configure and use the logger:
 
    ```python
-   from chutils import setup_logger, ChutilsLogger
+   from chutils import setup_logger_from_config, ChutilsLogger
 
    # Automatically reads settings from [Logging] section in config.yml
-   logger: ChutilsLogger = setup_logger()
+   logger: ChutilsLogger = setup_logger_from_config()
 
    logger.info("Application started.")
    logger.devdebug("Deep debug message (level 9).")
@@ -307,8 +315,9 @@ except PathTraversalError as e:
 
 ### Configuration (`chutils.config`)
 
-- `get_config_value(section, key, fallback)` / `aget_config()`
-- `get_config_int`, `get_config_boolean`, `get_config_list`, `get_config_path`
+- `get_config_value(section, key, fallback=None, required=False)` / `aget_config()`
+- `get_config_int`, `get_config_boolean`, `get_config_list`, `get_config_path` (all support `fallback` and `required`
+  parameters)
 - `save_config_value(section, key, value, notify=True)` / `asave_config_value()`
 - Use `notify=False` to update the file without triggering Hot-Reload callbacks.
 
@@ -321,7 +330,7 @@ except PathTraversalError as e:
 
 - `SecretManager(service_name, prefix)`
 - `save_secret` / `asave_secret`
-- `get_secret` / `aget_secret`
+- `get_secret(key, fallback=None, required=False)` / `aget_secret(...)`
 - `delete_secret` / `adelete_secret`
 
 ### Decorators (`chutils.decorators`)
@@ -431,4 +440,3 @@ See [docs/ai_lint.md](docs/ai_lint.md) for more details.
 ## License
 
 The project is distributed under the MIT License.
-