Metadata-Version: 2.5
Name: quadkit
Version: 0.0.2
Summary: Async-first DI/IoC framework for Python — core package
Project-URL: Homepage, https://quadkit.dev
Project-URL: Repository, https://github.com/dbtinoy-/quadkit
Project-URL: Documentation, https://quadkit.dev
Project-URL: Issues, https://github.com/dbtinoy-/quadkit/issues
Project-URL: Changelog, https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md
Author-email: Quadkit Framework Team <team@quadkit.dev>
Maintainer-email: Quadkit Framework Team <team@quadkit.dev>
License: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Keywords: async,dependency-injection,framework,ioc,provider-pattern
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: orjson>=3.0.0
Requires-Dist: pydantic>=2.10.0
Requires-Dist: quadkit-contracts>=0.0.2
Requires-Dist: structlog<27,>=25.1.0
Provides-Extra: codegen
Requires-Dist: jinja2>=3.1.0; extra == 'codegen'
Provides-Extra: dev
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
Requires-Dist: ruff>=0.16.4; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs>=1.4.0; extra == 'docs'
Provides-Extra: security
Requires-Dist: cryptography>=41.0.0; extra == 'security'
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
Requires-Dist: pytest-mock>=3.10.0; extra == 'test'
Requires-Dist: pytest>=8.0.0; extra == 'test'
Provides-Extra: web
Requires-Dist: quadkit-web[granian]>=0.0.2; extra == 'web'
Description-Content-Type: text/markdown

# quadkit

Async-first DI/IoC framework for Python — core package.

![Quadkit demo](docs/gifs/hero/quadkit-hero.gif)

---

## Overview

Quadkit is the foundation package for the wider Quadkit ecosystem. It provides the
DI/IoC container, application lifecycle, configuration system, provider protocol,
exception hierarchy, and structured logging foundation.

Async-first by design: application boot, provider lifecycle, I/O paths, and
resolution workflows are built for async Python. Use `Application.boot(...)` to
assemble modules and providers into a running app.

## Install

```bash
uv add quadkit
# Optional extras
uv add "quadkit[security]"
```

## Quick Start

```python
from quadkit import Application
from quadkit.di.module import Module, module
from quadkit.app.standard import StandardModule


@module(imports=[StandardModule.configure()])
class AppModule(Module):
    pass


async with Application.boot(modules=[AppModule]) as app:
    # use app.container to resolve services
    ...
```

## Configuration

> **Zero-config usage:** Call `StandardModule.configure()` with no arguments to use defaults.

### Option 1 — YAML file

```yaml
# application.yaml
app_name: my-app
debug: false
```

### Option 2 — Profiles + Environment Variables *(recommended)*

```bash
export QK_PROFILE=production
# Environment variables for each field
```

### Option 3 — Python

```python
from quadkit.config.main import QuadkitConfig

config = QuadkitConfig(...)
StandardModule.configure(config_class=QuadkitConfig)
```

## Module Factory Methods

| Method | Description |
|--------|-------------|
| `StandardModule.configure(...)` | Configure with explicit config, sources, or overrides |
| `StandardModule.build_providers()` | Provider list for `Application.boot(providers=[...])` |
| `CoreModule.configure(...)` | Stripped-down kernel without serialization or concurrency |

## Key Features

- **DI Container** — register services as singleton, transient, or scoped; resolve via `await container.resolve(ServiceType)`
- **Provider Lifecycle** — `register()`, `boot()`, `shutdown()` hooks with priority ordering
- **Result Pattern** — `Result[T, E]` for expected domain failures, exceptions for infrastructure errors
- **Module System** — compose applications from reusable modules with explicit exports
- **Structured Logging** — structlog-based logging via `get_logger(__name__)`
- **Configuration** — Pydantic-based config with YAML, environment variables, and profile support

## Testing

```python
async with Application.boot(modules=[StandardModule.configure()]) as app:
    # your test code
    ...
```

## Key Source Files

| File | What it contains |
|------|-----------------|
| `src/quadkit/app/base.py` | Application lifecycle and boot flow |
| `src/quadkit/app/standard.py` | StandardModule.configure() with all kernel providers |
| `src/quadkit/di/container/container.py` | Container registration, scope, and diagnostics |
| `src/quadkit/result/` | Result, Ok, Err, and helpers |
| `src/quadkit/config/main.py` | QuadkitConfig and configuration system |
