logdruid 0.1.0.dev1__tar.gz → 0.1.0.dev2__tar.gz

logdruid-0.1.0.dev2/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: logdruid
+Version: 0.1.0.dev2
+Summary: A drop-in logging setup layer for multi-process applications, built on loguru.
+License-Expression: MIT
+License-File: LICENSE
+Author: Frank Herbrand
+Author-email: f.herbrand@hzdr.de
+Requires-Python: >=3.11,<4.0
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.15
+Requires-Dist: loguru (>=0.7.3)
+Description-Content-Type: text/markdown
+
+# logdruid
+
+[![PyPI version](https://img.shields.io/pypi/v/logdruid.svg)](https://pypi.org/project/logdruid/)
+[![Tests](https://github.com/fherb2/logdruid/actions/workflows/tests.yml/badge.svg)](https://github.com/fherb2/logdruid/actions/workflows/tests.yml)
+
+A drop-in logging setup layer for multi-process applications, built on
+[loguru](https://loguru.readthedocs.io/).
+
+**Installation, usage, configuration and API:
+<https://fherb2.github.io/logdruid/>**
+
+## What it is for
+
+loguru is a logging library for Python with exactly one global logger. In an
+application with several processes, loguru alone reaches its limits: each
+process started with `spawn` has its own logger with its own outputs; a
+shared output across processes goes through a queue whose lock spans all
+processes, so a process killed hard while holding it can block logging
+everywhere; and messages from libraries that report through the standard
+`logging` module do not appear in loguru's outputs.
+
+logdruid is a setup layer around loguru for exactly this case: applications
+– not libraries – with several processes. It does not build a logging API of
+its own: you keep reporting with loguru's logger, unchanged. logdruid only
+sets it up and adds what loguru does not offer: one shared output for all
+processes, ordered by time, without a lock across process boundaries; taking
+over the messages from `logging`; and a configuration in a file of its own.
+
+For an application with a single process, loguru alone is enough, as it is
+when each process may write to its own file and the order across processes
+does not matter. Libraries should use neither loguru nor logdruid but report
+through `logging`.
+
+## Features
+
+| Feature | loguru alone | with logdruid |
+| --- | --- | --- |
+| Reporting with `logger.info(...)` etc., levels `TRACE` to `CRITICAL` including `SUCCESS` | yes | yes, the same logger and the same API |
+| Console and file, rotation and retention of the file, format, colours | yes | yes, set in the configuration file |
+| Exceptions with extended tracebacks, optionally with variable values | yes | yes |
+| All processes write into one shared output | yes, through a shared queue with a lock across all processes | yes, through a pipe of its own per child process, without a shared lock |
+| A process killed hard does not hold up the others | not guaranteed | yes |
+| Messages of all processes ordered by time | no, order of arrival | yes, with an adjustable time window |
+| Minimum level per name of a message (module, logger) | yes, through a filter | yes |
+| Minimum level per process | no | yes |
+| Taking over messages from `logging` | only as a code example in loguru's documentation | yes, with the logger's name and with level translation per logger |
+| Configuration from a file, precedence defaults < application < file < command line | no, only environment variables | yes |
+| Mistakes in the configuration do not stop the application | no | yes, they only produce a warning |
+
+## For contributors
+
+Design rules and rationale are in
+[`running_implementation_doc/`](https://github.com/fherb2/logdruid/tree/main/running_implementation_doc)
+(in German).
+
+## License
+
+MIT, see [`LICENSE`](https://github.com/fherb2/logdruid/blob/main/LICENSE).
+

logdruid-0.1.0.dev2/README.md

@@ -0,0 +1,58 @@
+# logdruid
+
+[![PyPI version](https://img.shields.io/pypi/v/logdruid.svg)](https://pypi.org/project/logdruid/)
+[![Tests](https://github.com/fherb2/logdruid/actions/workflows/tests.yml/badge.svg)](https://github.com/fherb2/logdruid/actions/workflows/tests.yml)
+
+A drop-in logging setup layer for multi-process applications, built on
+[loguru](https://loguru.readthedocs.io/).
+
+**Installation, usage, configuration and API:
+<https://fherb2.github.io/logdruid/>**
+
+## What it is for
+
+loguru is a logging library for Python with exactly one global logger. In an
+application with several processes, loguru alone reaches its limits: each
+process started with `spawn` has its own logger with its own outputs; a
+shared output across processes goes through a queue whose lock spans all
+processes, so a process killed hard while holding it can block logging
+everywhere; and messages from libraries that report through the standard
+`logging` module do not appear in loguru's outputs.
+
+logdruid is a setup layer around loguru for exactly this case: applications
+– not libraries – with several processes. It does not build a logging API of
+its own: you keep reporting with loguru's logger, unchanged. logdruid only
+sets it up and adds what loguru does not offer: one shared output for all
+processes, ordered by time, without a lock across process boundaries; taking
+over the messages from `logging`; and a configuration in a file of its own.
+
+For an application with a single process, loguru alone is enough, as it is
+when each process may write to its own file and the order across processes
+does not matter. Libraries should use neither loguru nor logdruid but report
+through `logging`.
+
+## Features
+
+| Feature | loguru alone | with logdruid |
+| --- | --- | --- |
+| Reporting with `logger.info(...)` etc., levels `TRACE` to `CRITICAL` including `SUCCESS` | yes | yes, the same logger and the same API |
+| Console and file, rotation and retention of the file, format, colours | yes | yes, set in the configuration file |
+| Exceptions with extended tracebacks, optionally with variable values | yes | yes |
+| All processes write into one shared output | yes, through a shared queue with a lock across all processes | yes, through a pipe of its own per child process, without a shared lock |
+| A process killed hard does not hold up the others | not guaranteed | yes |
+| Messages of all processes ordered by time | no, order of arrival | yes, with an adjustable time window |
+| Minimum level per name of a message (module, logger) | yes, through a filter | yes |
+| Minimum level per process | no | yes |
+| Taking over messages from `logging` | only as a code example in loguru's documentation | yes, with the logger's name and with level translation per logger |
+| Configuration from a file, precedence defaults < application < file < command line | no, only environment variables | yes |
+| Mistakes in the configuration do not stop the application | no | yes, they only produce a warning |
+
+## For contributors
+
+Design rules and rationale are in
+[`running_implementation_doc/`](https://github.com/fherb2/logdruid/tree/main/running_implementation_doc)
+(in German).
+
+## License
+
+MIT, see [`LICENSE`](https://github.com/fherb2/logdruid/blob/main/LICENSE).

{logdruid-0.1.0.dev1 → logdruid-0.1.0.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "logdruid"
-version = "0.1.0.dev1"
+version = "0.1.0.dev2"
 description = "A drop-in logging setup layer for multi-process applications, built on loguru."
 readme = "README.md"
 requires-python = ">=3.11,<4.0"

logdruid-0.1.0.dev1/PKG-INFO

@@ -1,97 +0,0 @@
-Metadata-Version: 2.4
-Name: logdruid
-Version: 0.1.0.dev1
-Summary: A drop-in logging setup layer for multi-process applications, built on loguru.
-License-Expression: MIT
-License-File: LICENSE
-Author: Frank Herbrand
-Author-email: f.herbrand@hzdr.de
-Requires-Python: >=3.11,<4.0
-Classifier: Programming Language :: Python :: 3
-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: Programming Language :: Python :: 3.15
-Requires-Dist: loguru (>=0.7.3)
-Description-Content-Type: text/markdown
-
-# logdruid
-
-[![PyPI version](https://img.shields.io/pypi/v/logdruid.svg)](https://pypi.org/project/logdruid/)
-[![Tests](https://github.com/fherb2/logdruid/actions/workflows/tests.yml/badge.svg)](https://github.com/fherb2/logdruid/actions/workflows/tests.yml)
-
-A drop-in logging setup layer for multi-process applications, built on
-[loguru](https://loguru.readthedocs.io/).
-
-logdruid does not replace loguru's API — it uses it unchanged — and adds
-what a multi-process application needs on top: a single, time-ordered
-output across process boundaries, without a lock shared between
-processes, and the ability to take over messages from libraries that
-report through the standard `logging` module.
-
-## Installation
-
-```bash
-pip install logdruid
-```
-
-Requires Python 3.11 or later.
-
-## Usage
-
-Main process, once, before any child process is created:
-
-```python
-import logdruid
-from logdruid import logger
-
-logdruid.setup(config_path, cli_level=args.log_level)
-logger.success("Logging active")
-```
-
-Per child process, in the main process:
-
-```python
-link = logdruid.link("raw_writer")
-process = ctx.Process(target=raw_writer_prc, args=(link, ...),
-                       name="raw_writer")
-process.start()
-link.release()
-```
-
-First thing in the child process (after ignoring `SIGINT`):
-
-```python
-logdruid.attach(link)
-```
-
-At the end of the main process, after the children have ended:
-
-```python
-logdruid.shutdown()
-```
-
-Application modules report through `from logdruid import logger` — loguru's
-own global logger, unchanged. Libraries that report through the standard
-`logging` module need no changes of their own; logdruid takes over their
-messages and applies the level translations configured for them.
-
-## Configuration
-
-Everything logdruid-specific lives in a `logdruid.toml` file next to the
-application's entry point. A fully commented example, including how to
-assign levels per process and per logger and how to translate a library's
-levels into the application's own scheme, is in
-[`examples/logdruid.toml`](examples/logdruid.toml).
-
-## Documentation
-
-The full set of project-wide rules and design rationale is in
-[`running_implementation_doc/implementierungsdoku.md`](running_implementation_doc/implementierungsdoku.md)
-(in German).
-
-## License
-
-MIT, see [`LICENSE`](LICENSE).
-

logdruid-0.1.0.dev1/README.md

@@ -1,78 +0,0 @@
-# logdruid
-
-[![PyPI version](https://img.shields.io/pypi/v/logdruid.svg)](https://pypi.org/project/logdruid/)
-[![Tests](https://github.com/fherb2/logdruid/actions/workflows/tests.yml/badge.svg)](https://github.com/fherb2/logdruid/actions/workflows/tests.yml)
-
-A drop-in logging setup layer for multi-process applications, built on
-[loguru](https://loguru.readthedocs.io/).
-
-logdruid does not replace loguru's API — it uses it unchanged — and adds
-what a multi-process application needs on top: a single, time-ordered
-output across process boundaries, without a lock shared between
-processes, and the ability to take over messages from libraries that
-report through the standard `logging` module.
-
-## Installation
-
-```bash
-pip install logdruid
-```
-
-Requires Python 3.11 or later.
-
-## Usage
-
-Main process, once, before any child process is created:
-
-```python
-import logdruid
-from logdruid import logger
-
-logdruid.setup(config_path, cli_level=args.log_level)
-logger.success("Logging active")
-```
-
-Per child process, in the main process:
-
-```python
-link = logdruid.link("raw_writer")
-process = ctx.Process(target=raw_writer_prc, args=(link, ...),
-                       name="raw_writer")
-process.start()
-link.release()
-```
-
-First thing in the child process (after ignoring `SIGINT`):
-
-```python
-logdruid.attach(link)
-```
-
-At the end of the main process, after the children have ended:
-
-```python
-logdruid.shutdown()
-```
-
-Application modules report through `from logdruid import logger` — loguru's
-own global logger, unchanged. Libraries that report through the standard
-`logging` module need no changes of their own; logdruid takes over their
-messages and applies the level translations configured for them.
-
-## Configuration
-
-Everything logdruid-specific lives in a `logdruid.toml` file next to the
-application's entry point. A fully commented example, including how to
-assign levels per process and per logger and how to translate a library's
-levels into the application's own scheme, is in
-[`examples/logdruid.toml`](examples/logdruid.toml).
-
-## Documentation
-
-The full set of project-wide rules and design rationale is in
-[`running_implementation_doc/implementierungsdoku.md`](running_implementation_doc/implementierungsdoku.md)
-(in German).
-
-## License
-
-MIT, see [`LICENSE`](LICENSE).