Andrew K. Choi
91c7e04474
All checks were successful
continuous-integration/drone/push Build is passing
149 lines
7.5 KiB
Plaintext
149 lines
7.5 KiB
Plaintext
Metadata-Version: 2.4
|
||
Name: structlog
|
||
Version: 25.4.0
|
||
Summary: Structured Logging for Python
|
||
Project-URL: Documentation, https://www.structlog.org/
|
||
Project-URL: Changelog, https://github.com/hynek/structlog/blob/main/CHANGELOG.md
|
||
Project-URL: GitHub, https://github.com/hynek/structlog
|
||
Project-URL: Funding, https://github.com/sponsors/hynek
|
||
Project-URL: Tidelift, https://tidelift.com?utm_source=lifter&utm_medium=referral&utm_campaign=hynek
|
||
Project-URL: Mastodon, https://mastodon.social/@hynek
|
||
Project-URL: Bluesky, https://bsky.app/profile/hynek.me
|
||
Project-URL: Twitter, https://twitter.com/hynek
|
||
Author-email: Hynek Schlawack <hs@ox.cx>
|
||
License-Expression: MIT OR Apache-2.0
|
||
License-File: LICENSE-APACHE
|
||
License-File: LICENSE-MIT
|
||
License-File: NOTICE
|
||
Keywords: log,logging,structure,structured
|
||
Classifier: Development Status :: 5 - Production/Stable
|
||
Classifier: License :: OSI Approved :: Apache Software License
|
||
Classifier: License :: OSI Approved :: MIT License
|
||
Classifier: Programming Language :: Python :: 3.8
|
||
Classifier: Programming Language :: Python :: 3.9
|
||
Classifier: Programming Language :: Python :: 3.10
|
||
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: Typing :: Typed
|
||
Requires-Python: >=3.8
|
||
Requires-Dist: typing-extensions; python_version < '3.11'
|
||
Description-Content-Type: text/markdown
|
||
|
||
<p align="center">
|
||
<img
|
||
src="https://www.structlog.org/en/stable/_static/structlog_logo_small.png"
|
||
alt="structlog mascot"
|
||
/>
|
||
</p>
|
||
|
||
*structlog* is *the* production-ready logging solution for Python:
|
||
|
||
- **Simple**: Everything is about **functions** that take and return **dictionaries** – all hidden behind **familiar APIs**.
|
||
- **Powerful**: Functions and dictionaries aren’t just simple but also powerful.
|
||
*structlog* leaves *you* in control.
|
||
- **Fast**: *structlog* is not hamstrung by designs of yore.
|
||
Its flexibility comes not at the price of performance.
|
||
|
||
Thanks to its flexible design, *you* choose whether you want *structlog* to take care of the **output** of your log entries or whether you prefer to **forward** them to an existing logging system like the standard library's `logging` module.
|
||
|
||
The output format is just as flexible and *structlog* comes with support for JSON, [*logfmt*](https://brandur.org/logfmt), as well as pretty console output out-of-the-box:
|
||
|
||
[](https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true)
|
||
|
||
|
||
## Sponsors
|
||
|
||
*structlog* would not be possible without our [amazing sponsors](https://github.com/sponsors/hynek).
|
||
Especially those generously supporting us at the *The Organization* tier and higher:
|
||
|
||
<!-- pause-short -->
|
||
|
||
<p align="center">
|
||
|
||
<!-- [[[cog
|
||
import pathlib, tomllib
|
||
|
||
for sponsor in tomllib.loads(pathlib.Path("pyproject.toml").read_text())["tool"]["sponcon"]["sponsors"]:
|
||
print(f'<a href="{sponsor["url"]}"><img title="{sponsor["title"]}" src="https://www.structlog.org/en/25.4.0/_static/sponsors/{sponsor["img"]}" width="190" /></a>')
|
||
]]] -->
|
||
<a href="https://www.variomedia.de/"><img title="Variomedia AG" src="https://www.structlog.org/en/25.4.0/_static/sponsors/Variomedia.svg" width="190" /></a>
|
||
<a href="https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek"><img title="Tidelift" src="https://www.structlog.org/en/25.4.0/_static/sponsors/Tidelift.svg" width="190" /></a>
|
||
<a href="https://klaviyo.com/"><img title="Klaviyo" src="https://www.structlog.org/en/25.4.0/_static/sponsors/Klaviyo.svg" width="190" /></a>
|
||
<a href="https://privacy-solutions.org/"><img title="Privacy Solutions" src="https://www.structlog.org/en/25.4.0/_static/sponsors/Privacy-Solutions.svg" width="190" /></a>
|
||
<a href="https://www.emsys-renewables.com/"><img title="emsys renewables" src="https://www.structlog.org/en/25.4.0/_static/sponsors/emsys-renewables.svg" width="190" /></a>
|
||
<a href="https://filepreviews.io/"><img title="FilePreviews" src="https://www.structlog.org/en/25.4.0/_static/sponsors/FilePreviews.svg" width="190" /></a>
|
||
<a href="https://polar.sh/"><img title="Polar" src="https://www.structlog.org/en/25.4.0/_static/sponsors/Polar.svg" width="190" /></a>
|
||
<!-- [[[end]]] -->
|
||
|
||
</p>
|
||
|
||
<!-- continue-short -->
|
||
|
||
<p align="center">
|
||
<strong>Please consider <a href="https://github.com/sponsors/hynek">joining them</a> to help make <em>structlog</em>’s maintenance more sustainable!</strong>
|
||
</p>
|
||
|
||
## Introduction
|
||
|
||
*structlog* has been successfully used in production at every scale since **2013**, while embracing cutting-edge technologies like *asyncio*, context variables, or type hints as they emerged.
|
||
Its paradigms proved influential enough to [help design](https://twitter.com/sirupsen/status/638330548361019392) structured logging [packages across ecosystems](https://github.com/sirupsen/logrus).
|
||
|
||
## Project Links
|
||
|
||
- [**Get Help**](https://stackoverflow.com/questions/tagged/structlog) (use the *structlog* tag on Stack Overflow)
|
||
- [**PyPI**](https://pypi.org/project/structlog/)
|
||
- [**GitHub**](https://github.com/hynek/structlog)
|
||
- [**Documentation**](https://www.structlog.org/)
|
||
- [**Changelog**](https://github.com/hynek/structlog/tree/main/CHANGELOG.md)
|
||
- [**Third-party Extensions**](https://github.com/hynek/structlog/wiki/Third-party-Extensions)
|
||
|
||
|
||
## *structlog* for Enterprise
|
||
|
||
Available as part of the [Tidelift Subscription](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek).
|
||
|
||
The maintainers of *structlog* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications.
|
||
Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
|
||
|
||
|
||
## Release Information
|
||
|
||
### Added
|
||
|
||
- Support for Python 3.14 and Python 3.13.4.
|
||
|
||
Python 3.14 has an backwards-incompatible change to `logging.Logger.isEnabledFor()` (it now always returns False if a log entry is in flight) that has been backported to 3.13.4 (expected on 2025-06-03).
|
||
It mainly affects `structlog.stdlib.filter_by_level()`.
|
||
[#723](https://github.com/hynek/structlog/pull/723)
|
||
|
||
- `structlog.tracebacks` now handles [exception groups](https://docs.python.org/3/library/exceptions.html#exception-groups).
|
||
`structlog.tracebacks.Stack` has two new fields, `is_group: bool` and `exceptions: list[Trace]`.
|
||
This works similarly to what Rich v14.0.0 does.
|
||
[#720](https://github.com/hynek/structlog/pull/720)
|
||
|
||
|
||
### Fixed
|
||
|
||
- `structlog.processors.ExceptionPrettyPrinter` now respects the *exception_formatter* arguments instead of always using the default formatter.
|
||
[#724](https://github.com/hynek/structlog/pull/724)
|
||
|
||
|
||
---
|
||
|
||
[Full Changelog →](https://www.structlog.org/en/stable/changelog.html)
|
||
|
||
|
||
## Credits
|
||
|
||
*structlog* is written and maintained by [Hynek Schlawack](https://hynek.me/).
|
||
The idea of bound loggers is inspired by previous work by [Jean-Paul Calderone](https://github.com/exarkun) and [David Reid](https://github.com/dreid).
|
||
|
||
The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *structlog*’s [Tidelift subscribers](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek), and all my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).
|
||
|
||
The logs-loving beaver logo has been contributed by [Lynn Root](https://www.roguelynn.com).
|
||
|
||
|