chutils 2.7.4__tar.gz → 2.9.0__tar.gz

{chutils-2.7.4 → chutils-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chutils
-Version: 2.7.4
+Version: 2.9.0
 Summary: Набор простых и удобных утилит для Python, который избавляет от рутины при работе с конфигурацией и логированием в новых проектах.
 License-Expression: MIT
 License-File: LICENSE
@@ -13,15 +13,20 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: crypto
 Provides-Extra: date
 Provides-Extra: full
 Provides-Extra: json
+Provides-Extra: metrics
 Provides-Extra: otel
 Provides-Extra: pydantic
 Provides-Extra: rich
 Provides-Extra: secrets
 Provides-Extra: testing
+Provides-Extra: text
 Provides-Extra: watch
+Requires-Dist: cryptography (>=42.0.0) ; extra == "crypto"
+Requires-Dist: cryptography (>=42.0.0) ; extra == "full"
 Requires-Dist: keyring (>=25.7.0)
 Requires-Dist: keyring (>=25.7.0) ; extra == "full"
 Requires-Dist: keyring (>=25.7.0) ; extra == "secrets"
@@ -31,6 +36,8 @@ 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: prometheus-client (>=0.20.0,<1.0.0) ; extra == "full"
+Requires-Dist: prometheus-client (>=0.20.0,<1.0.0) ; extra == "metrics"
 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")
@@ -44,8 +51,11 @@ 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: rapidfuzz (>=3.9.0) ; extra == "full"
+Requires-Dist: rapidfuzz (>=3.9.0) ; extra == "text"
 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"
 Description-Content-Type: text/markdown
@@ -95,6 +105,10 @@ Every time you start a new project, you have to solve the same tasks:
 - **🌐 Remote Configuration:** Load settings from HTTP/HTTPS endpoints with background polling and fallback support.
 - **🔄 Hot-Reload:** Support for automatic configuration reloading on file changes without restart (requires
   `pip install chutils[watch]`).
+- **🛡️ 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`.
 - **⚡ Async Ready:** Most core functions have asynchronous versions (prefixed with `a`) for non-blocking execution.
 - **🚀 Ready to Use:** Just install and use.
 
@@ -212,10 +226,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).")
@@ -282,6 +296,22 @@ In environments like Docker or CI/CD where `keyring` is unavailable, you can sup
 - Set `CH_DISABLE_KEYRING_WARNING=true` in environment.
 - Or add `disable_keyring: true` under `secrets` section in `config.yml`.
 
+### 4. Safe Path Resolution
+
+Safely resolve relative and absolute paths against a base directory to prevent directory traversal vulnerabilities:
+
+```python
+from chutils.fs import resolve_safe_path
+from chutils.exceptions import PathTraversalError
+
+try:
+    # Resolves path relative to the base directory and checks if it's safe
+    safe_path = resolve_safe_path("user_file.txt", base_dir="./sandbox")
+    print(f"Safe absolute path: {safe_path}")
+except PathTraversalError as e:
+    print(f"Path traversal detected! Attempted: {e.context.get('attempted_path')}")
+```
+
 ## API Overview
 
 ### Configuration (`chutils.config`)
@@ -310,6 +340,11 @@ In environments like Docker or CI/CD where `keyring` is unavailable, you can sup
 - `@retry`: Automatically retries a function if it fails. Supports sync/async, backoff, jitter, and exception filtering.
 - `@cli_command`: Turns any function into a standalone CLI script with automatic argument parsing.
 
+### File System (`chutils.fs`)
+
+- `resolve_safe_path(path, base_dir)`: Safely resolves path and checks for Path Traversal attempts.
+- `ensure_dir(path)`: Ensures directory exists.
+
 ### Time & Dates (`chutils.time`)
 
 - `utc_now()`: Returns a timezone-aware UTC datetime.
@@ -388,6 +423,20 @@ Trace exactly where each configuration value comes from:
 chutils config debug
 ```
 
+### 6. AI-Readiness Linter
+
+Perform a static audit of your codebase to ensure it is optimized for AI developers and agents:
+
+```bash
+# Run linter on the current project
+chutils dev ai-lint
+
+# Run linter in strict mode with ignored paths
+chutils dev ai-lint --strict --ignore "temp/,build/"
+```
+
+See [docs/ai_lint.md](docs/ai_lint.md) for more details.
+
 ## License
 
 The project is distributed under the MIT License.