chutils 3.0.0__tar.gz → 3.1.0__tar.gz

chutils-3.1.0/.gitignore

@@ -0,0 +1,185 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+!examples/.env
+
+# 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 specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Project-specific documentation
+PUBLISHING.md
+project.txt
+changelog.txt
+*.log.*
+*.log
+
+# Local chutils cache
+.chutils/

{chutils-3.0.0 → chutils-3.1.0}/GEMINI.md

@@ -34,6 +34,7 @@
     - Вместо `Optional[T]` обязательно используйте `T | None`.
     - Вместо `List[T]`, `Dict[K, V]`, `Tuple[T, ...]` используйте встроенные типы `list[T]`, `dict[K, V]`,
       `tuple[T, ...]` без импорта из `typing`.
+- **Использование uv**: Проект использует менеджер пакетов `uv` (в корне присутствует `uv.lock`). Для запуска любых скриптов, команд CLI или тестов AI-агенты ОБЯЗАТЕЛЬНО должны использовать `uv run` (например, `uv run chutils ...`, `uv run pytest`). Прямой запуск через интерпретатор `.venv` или глобальный `python` не рекомендуется.
 - **Документация**: Подробные советы для AI находятся в `docs/ai_hints.md` и `docs/INTEGRATION_AI.md`.
 
 ## 3. Тестирование

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chutils
-Version: 3.0.0
+Version: 3.1.0
 Summary: Набор простых и удобных утилит для Python, который избавляет от рутины при работе с конфигурацией и логированием в новых проектах.
 Author-email: Chu4hel <sergeiivanov636@gmail.com>
 License-Expression: MIT
@@ -107,7 +107,11 @@ Every time you start a new project, you have to solve the same tasks:
 - **🛡️ Secure Paths:** Prevent Path Traversal attacks by safely resolving file paths against a base directory using
   `resolve_safe_path()`.
 - **🤖 AI Linter:** Run static analysis checks on your codebase to ensure AI readiness (strict type hints, structured
-  docstrings, API map sync) via `chutils dev ai-lint`.
+  docstrings, API map sync, and file dependency synchronization) via `chutils dev ai-lint`.
+- **✅ Data Validation (chutils.validation):** An all-in-one Pydantic-based data and JSON validation module featuring
+  `@validate_call` decorator for function argument checks and rich exception formatting.
+- **🩺 Diagnostics API (chutils.diagnostics):** An asynchronous, thread-safe health checking framework with built-in
+  checks (keyring, config) and integrations for popular web frameworks (FastAPI, Flask).
 - **⚡ Async Ready:** Most core functions have asynchronous versions (prefixed with `a`) for non-blocking execution.
 - **🚀 Ready to Use:** Just install and use.
 
@@ -333,6 +337,22 @@ except PathTraversalError as e:
 - `get_secret(key, fallback=None, required=False)` / `aget_secret(...)`
 - `delete_secret` / `adelete_secret`
 
+### Environment Manifest (`chutils.env`)
+
+- `BaseEnvManifest`: Declarative specification of environment variables using Pydantic typing, automatic secret masking,
+  and `load()` classmethod.
+
+### Data Validation (`chutils.validation`)
+
+- `validate_data(model, data)`: Validates dictionaries or JSON strings against Pydantic models, raising
+  `ChutilsValidationError`.
+- `@validate_call`: Automatically validates function arguments using Pydantic.
+
+### Health Checking (`chutils.diagnostics`)
+
+- `DiagnosticsManager`: Registers and аsynchronously executes system health checks with timeouts.
+- Web Framework helpers: `get_fastapi_health_handler` and `get_flask_health_handler`.
+
 ### Decorators (`chutils.decorators`)
 
 - `@log_function_details`: Logs arguments, execution time, and result (uses `DEVDEBUG` level).
@@ -437,6 +457,21 @@ chutils dev ai-lint --strict --ignore "temp/,build/"
 
 See [docs/ai_lint.md](docs/ai_lint.md) for more details.
 
+### 7. Environment Variables Synchronization
+
+Keep `.env` and `.env.example` files in sync with format preservation, comments, and values masking:
+
+```bash
+# Compare .env and .env.example keys without making changes
+chutils dev sync-env --dry-run
+
+# Synchronize files automatically
+chutils dev sync-env --yes
+
+# Specify custom paths
+chutils dev sync-env --env-path .env.dev --example-path .env.dev.example
+```
+
 ## License
 
 The project is distributed under the MIT License.

{chutils-3.0.0 → chutils-3.1.0}/README.md

@@ -46,7 +46,11 @@ Every time you start a new project, you have to solve the same tasks:
 - **🛡️ Secure Paths:** Prevent Path Traversal attacks by safely resolving file paths against a base directory using
   `resolve_safe_path()`.
 - **🤖 AI Linter:** Run static analysis checks on your codebase to ensure AI readiness (strict type hints, structured
-  docstrings, API map sync) via `chutils dev ai-lint`.
+  docstrings, API map sync, and file dependency synchronization) via `chutils dev ai-lint`.
+- **✅ Data Validation (chutils.validation):** An all-in-one Pydantic-based data and JSON validation module featuring
+  `@validate_call` decorator for function argument checks and rich exception formatting.
+- **🩺 Diagnostics API (chutils.diagnostics):** An asynchronous, thread-safe health checking framework with built-in
+  checks (keyring, config) and integrations for popular web frameworks (FastAPI, Flask).
 - **⚡ Async Ready:** Most core functions have asynchronous versions (prefixed with `a`) for non-blocking execution.
 - **🚀 Ready to Use:** Just install and use.
 
@@ -272,6 +276,22 @@ except PathTraversalError as e:
 - `get_secret(key, fallback=None, required=False)` / `aget_secret(...)`
 - `delete_secret` / `adelete_secret`
 
+### Environment Manifest (`chutils.env`)
+
+- `BaseEnvManifest`: Declarative specification of environment variables using Pydantic typing, automatic secret masking,
+  and `load()` classmethod.
+
+### Data Validation (`chutils.validation`)
+
+- `validate_data(model, data)`: Validates dictionaries or JSON strings against Pydantic models, raising
+  `ChutilsValidationError`.
+- `@validate_call`: Automatically validates function arguments using Pydantic.
+
+### Health Checking (`chutils.diagnostics`)
+
+- `DiagnosticsManager`: Registers and аsynchronously executes system health checks with timeouts.
+- Web Framework helpers: `get_fastapi_health_handler` and `get_flask_health_handler`.
+
 ### Decorators (`chutils.decorators`)
 
 - `@log_function_details`: Logs arguments, execution time, and result (uses `DEVDEBUG` level).
@@ -376,6 +396,21 @@ chutils dev ai-lint --strict --ignore "temp/,build/"
 
 See [docs/ai_lint.md](docs/ai_lint.md) for more details.
 
+### 7. Environment Variables Synchronization
+
+Keep `.env` and `.env.example` files in sync with format preservation, comments, and values masking:
+
+```bash
+# Compare .env and .env.example keys without making changes
+chutils dev sync-env --dry-run
+
+# Synchronize files automatically
+chutils dev sync-env --yes
+
+# Specify custom paths
+chutils dev sync-env --env-path .env.dev --example-path .env.dev.example
+```
+
 ## License
 
 The project is distributed under the MIT License.

chutils-3.1.0/ai-lint.toml

@@ -0,0 +1,33 @@
+[dependencies]
+# При изменении исходного кода chutils необходимо перегенерировать карту API и семантический индекс
+"src/chutils/**/*.py" = ["api_map.md", "project_index.json"]
+
+# При создании новых правил линтера необходимо дополнить документацию по линтеру и командам разработчика
+"new:src/chutils/dev/rules/*.py" = ["docs/ai_lint.md", "docs/cli/dev.md"]
+
+# При изменении CLI команд необходимо обновить соответствующее руководство
+"src/chutils/commands/dev/**/*.py" = ["docs/cli/dev.md"]
+"src/chutils/commands/env.py" = ["docs/cli/env.md"]
+"src/chutils/commands/secrets.py" = ["docs/cli/secrets.md"]
+"src/chutils/commands/config.py" = ["docs/cli/config.md"]
+"src/chutils/commands/init.py" = ["docs/cli/init.md"]
+"src/chutils/commands/paths.py" = ["docs/cli/show_paths.md"]
+"src/chutils/commands/pypi.py" = ["docs/cli/pypi.md"]
+"src/chutils/commands/template.py" = ["docs/cli/template.md"]
+"src/chutils/commands/validate.py" = ["docs/cli/validate.md"]
+
+# При изменении модулей веб-скрейпинга и капчи
+"src/chutils/scraping/**/*.py" = ["docs/scraping.md"]
+"src/chutils/scraping/captcha/**/*.py" = ["docs/captcha.md"]
+
+# При изменении HTTP-клиента
+"src/chutils/web/**/*.py" = ["docs/web.md"]
+
+# При изменении системы плагинов
+"src/chutils/plugins/**/*.py" = ["docs/plugins.md"]
+
+# При изменении фикстур тестирования
+"src/chutils/testing/**/*.py" = ["docs/testing.md"]
+
+# При обновлении пакетов и зависимостей в pyproject.toml
+"pyproject.toml" = ["docs/dependencies.md"]