Metadata-Version: 2.4
Name: logbook-stubs
Version: 0.3.0
Summary: Type stubs for logbook
Project-URL: Repository, https://github.com/hongquan/chameleon-log.git
Author-email: Nguyễn Hồng Quân <ng.hong.quan@gmail.com>
License-Expression: Apache-2.0
Keywords: logbook,logging,typed
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# logbook-stubs

Type stubs for [Logbook](https://pypi.org/project/Logbook/).

Provides `.pyi` files for type checking and IDE autocompletion.

## Installation

```bash
pip install logbook-stubs
```

or

```sh
uv add logbook-stubs --group test
```

## Usage

Type checkers use these stubs automatically when you `import logbook`.

Example:

```py
from __future__ import annotations
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from logbook.base import LogRecord


def emit(record: LogRecord) ->  None:
    ...
```

## Included

- `logbook.base`: `LogRecord`, levels
- `logbook.handlers`: Handlers, formatters

## Compatibility

Tested with Logbook >= 1.9.0. It does not cover all classes in Logbook yet.
