provide-foundation 0.0.0.dev0__tar.gz

provide_foundation-0.0.0.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 provide.io llc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

provide_foundation-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,469 @@
+Metadata-Version: 2.4
+Name: provide-foundation
+Version: 0.0.0.dev0
+Summary: Foundation Telemetry: An opinionated, developer-friendly telemetry wrapper for Python.
+Author-email: Tim Perkins <code@tim.life>
+Maintainer-email: "provide.io" <code@provide.io>
+License: Apache-2.0
+Keywords: telemetry,logging,tracing,python,pyvider
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: attrs>=23.1.0
+Requires-Dist: structlog>=25.3.0
+Requires-Dist: tomli_w>=1.0.0
+Provides-Extra: cli
+Requires-Dist: click>=8.1.7; extra == "cli"
+Provides-Extra: crypto
+Requires-Dist: cryptography>=45.0.7; extra == "crypto"
+Provides-Extra: opentelemetry
+Requires-Dist: opentelemetry-api>=1.22.0; extra == "opentelemetry"
+Requires-Dist: opentelemetry-sdk>=1.22.0; extra == "opentelemetry"
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.22.0; extra == "opentelemetry"
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.22.0; extra == "opentelemetry"
+Provides-Extra: all
+Requires-Dist: provide-foundation[cli,crypto,opentelemetry]; extra == "all"
+Dynamic: license-file
+
+# provide.foundation
+
+**A Comprehensive Python Foundation Library for Modern Applications**
+
+<p align="center">
+    <a href="https://pypi.org/project/provide-foundation/">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/provide-foundation.svg">
+    </a>
+    <a href="https://github.com/provide-io/provide-foundation/actions/workflows/ci.yml">
+        <img alt="CI Status" src="https://github.com/provide-io/provide-foundation/actions/workflows/ci.yml/badge.svg">
+    </a>
+    <a href="https://codecov.io/gh/provide-io/provide-foundation">
+        <img src="https://codecov.io/gh/provide-io/provide-foundation/branch/main/graph/badge.svg"/>
+    </a>
+    <a href="https://github.com/provide-io/provide-foundation/blob/main/LICENSE">
+        <img alt="License" src="https://img.shields.io/github/license/provide-io/provide-foundation.svg">
+    </a>
+</p>
+
+---
+
+**provide.foundation** is a comprehensive foundation library for Python applications, offering structured logging, CLI utilities, configuration management, error handling, and essential application building blocks. Built with modern Python practices, it provides the core infrastructure that production applications need.
+
+---
+
+## Installation
+
+```bash
+# Using uv (recommended)
+uv pip install provide-foundation
+
+# Using pip
+pip install provide-foundation
+```
+
+### Optional Dependencies
+
+provide.foundation has optional feature sets that require additional dependencies:
+
+| Feature | Install Command | Required For |
+|---------|----------------|--------------|
+| **Basic logging** | `pip install provide-foundation` | Core logging functionality |
+| **CLI framework** | `pip install provide-foundation[cli]` | Command-line interface features |
+| **Cryptography** | `pip install provide-foundation[crypto]` | Hash functions, digital signatures, certificates |
+| **OpenTelemetry** | `pip install provide-foundation[opentelemetry]` | Distributed tracing and metrics |
+| **All features** | `pip install provide-foundation[all]` | Everything above |
+
+> **Quick Start Tip**: For immediate use with just logging, install the base package. Add extras as needed.
+
+---
+
+## What's Included
+
+### Core Components
+
+#### **Structured Logging**
+Beautiful, performant logging built on `structlog` with emoji-enhanced visual parsing and zero configuration required.
+
+```python
+# Simple usage - works immediately with base install
+from provide.foundation import logger
+
+logger.info("Application started", version="1.0.0")
+logger.error("Database connection failed", host="db.example.com", retry_count=3)
+
+# Full setup with tracing/metrics (requires [opentelemetry] extra)
+from provide.foundation import setup_telemetry
+setup_telemetry()  # Configures logging + optional tracing/metrics
+```
+
+#### **CLI Framework**
+Build command-line interfaces with automatic help generation and component registration.
+
+> **Requires**: `pip install provide-foundation[cli]`
+
+```python
+# From examples/12_cli_application.py
+from provide.foundation.hub import register_command
+from provide.foundation.cli import echo_success
+
+@register_command("init", category="project")
+def init_command(name: str = "myproject", template: str = "default"):
+    """Initialize a new project."""
+    echo_success(f"Initializing project '{name}' with template '{template}'")
+```
+
+#### **Configuration Management**
+Flexible configuration system supporting environment variables, files, and runtime updates.
+
+```python
+# From examples/11_config_management.py
+from provide.foundation.config import BaseConfig, ConfigManager, field
+from attrs import define
+
+@define
+class AppConfig(BaseConfig):
+    app_name: str = field(default="my-app", description="Application name")
+    port: int = field(default=8080, description="Server port")
+    debug: bool = field(default=False, description="Debug mode")
+
+manager = ConfigManager()
+manager.register("app", config=AppConfig())
+config = manager.get("app")
+```
+
+#### **Error Handling**
+Comprehensive error handling with retry logic and error boundaries.
+
+```python
+# From examples/05_exception_handling.py
+from provide.foundation import logger, with_error_handling
+
+@with_error_handling
+def risky_operation():
+    """Operation that might fail."""
+    result = perform_calculation()
+    logger.info("operation_succeeded", result=result)
+    return result
+```
+
+#### **Cryptographic Utilities**
+Comprehensive cryptographic operations with modern algorithms and secure defaults.
+
+> **Requires**: `pip install provide-foundation[crypto]`
+
+```python
+from provide.foundation.crypto import hash_file, create_self_signed, sign_data
+
+# File hashing and verification
+hash_result = hash_file("document.pdf", algorithm="sha256")
+
+# Digital signatures
+signature = sign_data(data, private_key, algorithm="ed25519")
+
+# Certificate generation
+cert, key = create_self_signed("example.com", key_size=2048)
+```
+
+#### **File Operations**
+Atomic file operations with format support and safety guarantees.
+
+```python
+from provide.foundation.file import atomic_write, read_json, safe_copy
+
+# Atomic file operations
+atomic_write("config.json", {"key": "value"})
+data = read_json("config.json")
+
+# Safe file operations
+safe_copy("source.txt", "backup.txt")
+```
+
+#### **Console I/O**
+Enhanced console input/output with color support, JSON mode, and interactive prompts.
+
+```python
+from provide.foundation import pin, pout, perr
+
+# Colored output
+pout("Success!", color="green")
+perr("Error occurred", color="red")
+
+# Interactive input
+name = pin("What's your name?")
+password = pin("Enter password:", password=True)
+
+# JSON mode for scripts
+pout({"status": "ok", "data": results}, json=True)
+```
+
+#### **Platform Utilities**
+Cross-platform detection and system information gathering.
+
+```python
+from provide.foundation import platform
+
+# Platform detection
+if platform.is_linux():
+    logger.info("Running on Linux")
+
+system_info = platform.get_system_info()
+logger.info("System info", **system_info.to_dict())
+```
+
+#### **Process Execution**
+Safe subprocess execution with streaming and async support.
+
+```python
+from provide.foundation import process
+
+# Synchronous execution
+result = process.run_command(["git", "status"])
+if result.returncode == 0:
+    logger.info("Git status", output=result.stdout)
+
+# Streaming output
+for line in process.stream_command(["tail", "-f", "app.log"]):
+    logger.info("Log line", line=line)
+```
+
+#### **Registry Pattern**
+Flexible registry system for managing components and commands.
+
+```python
+# From examples/12_cli_application.py
+from provide.foundation.hub import Hub
+
+class DatabaseResource:
+    def __init__(self, name: str) -> None:
+        self.name = name
+        self.connected = False
+    
+    def __enter__(self):
+        """Initialize database connection."""
+        self.connected = True
+        return self
+
+hub = Hub()
+hub.add_component(DatabaseResource, name="database", dimension="resource", version="1.0.0")
+db_class = hub.get_component("database", dimension="resource")
+```
+
+See [examples/](examples/) for more comprehensive examples.
+
+---
+
+## Quick Start Examples
+
+### Building a CLI Application
+
+```python
+# From examples/12_cli_application.py
+from provide.foundation.hub import Hub, register_command
+from provide.foundation.cli import echo_info, echo_success
+
+@register_command("status", aliases=["st", "info"])
+def status_command(verbose: bool = False):
+    """Show system status."""
+    hub = Hub()
+    echo_info(f"Registered components: {len(hub.list_components())}")
+    echo_info(f"Registered commands: {len(hub.list_commands())}")
+
+if __name__ == "__main__":
+    hub = Hub()
+    cli = hub.create_cli(name="myapp", version="1.0.0")
+    cli()
+```
+
+### Configuration-Driven Application
+
+```python
+# From examples/11_config_management.py and examples/08_env_variables_config.py
+from provide.foundation import setup_telemetry, logger
+from provide.foundation.config import RuntimeConfig, env_field, ConfigManager
+from attrs import define
+
+@define
+class DatabaseConfig(RuntimeConfig):
+    """Database configuration from environment."""
+    host: str = env_field(default="localhost", env_var="DB_HOST")
+    port: int = env_field(default=5432, env_var="DB_PORT", parser=int)
+    database: str = env_field(default="mydb", env_var="DB_NAME")
+
+# Setup logging from environment
+setup_telemetry()  # Uses PROVIDE_* env vars automatically
+
+# Load configuration
+db_config = DatabaseConfig.from_env()
+logger.info("Database configured", host=db_config.host, port=db_config.port)
+```
+
+### Production Patterns
+
+```python
+# From examples/10_production_patterns.py
+from provide.foundation import logger, error_boundary
+import asyncio
+
+class ProductionService:
+    def __init__(self):
+        self.logger = logger.bind(component="production_service")
+        
+    async def process_batch(self, items):
+        """Process items with error boundaries."""
+        results = []
+        for item in items:
+            with error_boundary(self.logger, f"item_{item['id']}"):
+                result = await self.process_item(item)
+                results.append(result)
+        return results
+```
+
+---
+
+## Configuration
+
+### Environment Variables
+
+All configuration can be controlled through environment variables:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `PROVIDE_SERVICE_NAME` | Service identifier in logs | `None` |
+| `PROVIDE_LOG_LEVEL` | Minimum log level | `DEBUG` |
+| `PROVIDE_LOG_CONSOLE_FORMATTER` | Output format (`key_value` or `json`) | `key_value` |
+| `PROVIDE_LOG_OMIT_TIMESTAMP` | Remove timestamps from console | `false` |
+| `PROVIDE_LOG_FILE` | Log to file path | `None` |
+| `PROVIDE_LOG_MODULE_LEVELS` | Per-module log levels | `""` |
+| `PROVIDE_CONFIG_PATH` | Configuration file path | `None` |
+| `PROVIDE_ENV` | Environment (dev/staging/prod) | `dev` |
+| `PROVIDE_DEBUG` | Enable debug mode | `false` |
+| `PROVIDE_JSON_OUTPUT` | Force JSON output | `false` |
+| `PROVIDE_NO_COLOR` | Disable colored output | `false` |
+
+### Configuration Files
+
+Support for YAML, JSON, TOML, and .env files:
+
+```yaml
+# config.yaml
+service_name: my-app
+environment: production
+
+logging:
+  level: INFO
+  formatter: json
+  file: /var/log/myapp.log
+
+database:
+  host: db.example.com
+  port: 5432
+  pool_size: 20
+```
+
+---
+
+## Advanced Features
+
+### Contextual Logging
+
+```python
+# From examples/06_trace_logging.py
+from provide.foundation import logger
+
+# Add context via structured fields
+logger.info("request_processing",
+            request_id="req-123",
+            user_id="user-456",
+            method="GET",
+            path="/api/users")
+```
+
+### Timing and Profiling
+
+```python
+from provide.foundation import timed_block
+
+with timed_block(logger, "database_query"):
+    results = db.query("SELECT * FROM users")
+# Automatically logs: "database_query completed duration_seconds=0.123"
+```
+
+### Async Support
+
+```python
+import asyncio
+from provide.foundation import logger, process
+
+async def process_items(items):
+    for item in items:
+        logger.info("Processing", item_id=item.id)
+        await process_item(item)
+
+# Async process execution
+result = await process.async_run_command(["curl", "-s", "api.example.com"])
+logger.info("API response", status=result.returncode)
+
+# Thread-safe and async-safe logging
+asyncio.run(process_items(items))
+```
+
+### Example Files
+
+Complete working examples are available in the [examples/](examples/) directory:
+
+- `00_simple_start.py` - Zero-setup logging (base install)
+- `01_quick_start.py` - Full telemetry setup (requires [opentelemetry])
+- `02_custom_configuration.py` - Custom telemetry configuration
+- `03_named_loggers.py` - Module-specific loggers
+- `04_das_logging.py` - Domain-Action-Status pattern
+- `05_exception_handling.py` - Error handling patterns
+- `06_trace_logging.py` - Distributed tracing
+- `07_module_filtering.py` - Log filtering by module
+- `08_env_variables_config.py` - Environment-based config
+- `09_async_usage.py` - Async logging patterns
+- `10_production_patterns.py` - Production best practices
+- `11_config_management.py` - Complete configuration system
+- `12_cli_application.py` - Full CLI application example
+
+---
+
+## Performance
+
+- **Logging**: 14,000+ messages/second with emoji processing and structured logging
+- **Configuration**: Lazy loading with multi-source caching for optimal performance  
+- **File Operations**: Atomic writes with format detection prevent corruption
+- **Process Management**: Efficient streaming with async support and backpressure handling
+- **Cryptography**: Hardware-accelerated operations with secure algorithm defaults
+- **Platform Detection**: Cached system information for minimal overhead
+
+---
+
+## Contributing
+
+We welcome contributions! Please see:
+- [DEVELOPMENT.md](DEVELOPMENT.md) - Development setup and guidelines
+- [GitHub Issues](https://github.com/provide-io/provide-foundation/issues) - Bug reports and feature requests
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+---
+
+<p align="center">
+  Built by <a href="https://provide.io">Provide</a>
+</p>