small-logger 0.1.0__py3-none-any.whl

small_logger/__init__.py

@@ -0,0 +1,4 @@
+from .core import init_logger, get_logger
+
+
+__all__ = ["init_logger", "get_logger"]

small_logger/core.py

@@ -0,0 +1,134 @@
+# small_logger/core.py
+# -*- coding: utf-8 -*-
+"""
+small_logger: tiny, opinionated Loguru setup for applications.
+
+Features
+--------
+- Console + file sinks with platformdirs
+- Rotation/retention/compression for files
+- Multiline alignment (like your version)
+- Safe for PyInstaller (no __file__ assumptions)
+- Unhandled exception hook
+- Optional JSON logs for shipping/CI
+- Env-driven configuration overrides
+- Intercept stdlib logging (optional)
+"""
+from __future__ import annotations
+import sys
+from pathlib import Path
+from typing import TYPE_CHECKING, Literal
+from platformdirs import user_log_dir
+from loguru import logger as _loguru_logger
+
+if TYPE_CHECKING:
+    from loguru import Logger, Record
+
+__all__ = ["init_logger", "get_logger"]
+
+_logger_initialized: bool = False
+
+
+def _custom_format(record: Record) -> str:
+    # Loguru treats angle brackets as color tags, so <module> must be escaped.
+    function = record["function"].replace(r"<module>", r"\<module>")
+
+    # Loguru interprets { and } in the returned format string as placeholders.
+    record["message"] = record["message"].replace("{", "{{").replace("}", "}}")
+
+    left = (
+        f"<green>{record['time']:YYYY-MM-DD HH:mm:ss}</green> | "
+        f"<level>{record['level']:<8}</level> | "
+        f"<cyan>{record['name']}:{function}:{record['line']}</cyan>"
+    )
+    left_padded = left.ljust(100) + " | "
+
+    lines = record["message"].splitlines()
+
+    if not lines:
+        return f"{left_padded}<level></level>\n"
+
+    if len(lines) == 1:
+        return f"{left_padded}<level>{lines[0].rstrip()}</level>\n"
+
+    indent = " " * max(57, 36 + len((record["name"] or "") + record["function"] + str(record["line"])))
+    formatted_lines = [f"{left_padded}<level>{lines[0].rstrip()}</level>"]
+    for line in lines[1:]:
+        formatted_lines.append(f"{indent}  <level>{line.rstrip()}</level>")
+
+    return "\n".join(formatted_lines).rstrip() + "\n"
+
+
+def init_logger(
+        level: Literal["TRACE", "DEBUG", "INFO", "SUCCESS", "WARNING", "ERROR", "CRITICAL"] = "INFO",
+        app_name: str | None = None,
+        file: bool | None = None,
+) -> None:
+    """Initialize the global logger with console and optional file sinks. Call once at startup.
+
+    Parameters
+    ----------
+    level:
+        The logging level. Default is "INFO".
+    app_name:
+        Application name used to determine the log file location. Default is "slogger".
+    file:
+        Whether to log to a file. Defaults to True when app_name is given, False otherwise.
+    """
+    global _logger_initialized
+    if _logger_initialized:
+        return
+
+    _loguru_logger.remove()
+
+    if app_name is None:
+        app_name = "slogger"
+        if file is None:
+            file = False
+    else:
+        if file is None:
+            file = True
+
+    level_upper = level.upper()
+
+    _loguru_logger.add(  # type: ignore
+        sink=sys.stdout,
+        level=level_upper,
+        format=_custom_format,
+        enqueue=True,  # Non-blocking, thread-safe.
+    )
+
+    if file:
+        log_path: Path = Path(user_log_dir(appname=app_name)) / "app.log"
+        log_path.parent.mkdir(parents=True, exist_ok=True)
+        _loguru_logger.add(
+            sink=log_path,
+            level=level_upper,
+            format=_custom_format,  # type: ignore
+            rotation="00:00",  # New file each day at midnight.
+            retention="7 days",  # Deletion happens on the next app start, not immediately.
+            compression="zip",
+            encoding="utf-8",
+            enqueue=True,  # Non-blocking, thread-safe.
+        )
+        _loguru_logger.info(f"Logging to file: {log_path}")
+
+    _logger_initialized = True
+
+
+def get_logger(**extra) -> Logger:
+    """Return a logger bound with the given contextual key-value pairs."""
+    return _loguru_logger.bind(**extra)
+
+
+if __name__ == "__main__":
+    init_logger(level="TRACE")
+    logger = get_logger()
+    logger.trace("trace message\ntest new line")
+    logger.debug("debug message")
+    logger.info("info message")
+    logger.success("success message")
+    logger.warning("warning message")
+    logger.error("error message")
+    logger.critical("critical message")
+    logger.debug("message with accolades: {'name'} {{}} {{{{}}}}")

small_logger/py.typed

@@ -0,0 +1 @@
+

small_logger-0.1.0.dist-info/METADATA

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: small-logger
+Version: 0.1.0
+Summary: A tiny Loguru wrapper for styled logging
+Author: Seppe Van Bogaert
+License: MIT License
+        
+        Copyright (c) 2026 Seppe Van Bogaert
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: platformdirs>=3.0
+Dynamic: license-file
+
+# small-logger
+
+A tiny, opinionated [Loguru](https://github.com/Delgan/loguru) wrapper that gives your Python apps a consistent, readable log format in two lines of code.
+
+```
+2026-05-11 14:32:01 | INFO     | myapp:main:42                             | Server started on port 8080
+2026-05-11 14:32:01 | ERROR    | myapp:handle_request:87                   | Connection refused
+                                                                            | Traceback shown below
+```
+
+## Installation
+
+```
+uv add small-logger
+```
+
+```
+pip install small-logger
+```
+
+## Quick start
+
+```python
+from small_logger import init_logger, get_logger
+
+init_logger()  # call once at the start of your app
+
+logger = get_logger()
+logger.info("Server started")
+logger.warning("Disk usage above 80%")
+```
+
+## File logging
+
+Pass your app's name to enable automatic file logging:
+
+```python
+init_logger(app_name="my-app")
+```
+
+Logs are written to the platform-appropriate directory:
+
+| Platform | Path |
+|----------|------|
+| Windows  | `%LOCALAPPDATA%\my-app\Logs\app.log` |
+| macOS    | `~/Library/Logs/my-app/app.log` |
+| Linux    | `~/.local/state/my-app/log/app.log` |
+
+Files rotate daily at midnight, are kept for 7 days, and are compressed to `.zip` on rotation.
+
+## API
+
+### `init_logger`
+
+```python
+init_logger(
+    level="INFO",       # TRACE | DEBUG | INFO | SUCCESS | WARNING | ERROR | CRITICAL
+    app_name=None,      # enables file logging when provided
+    file=None,          # override file logging on/off explicitly
+)
+```
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `level` | `"INFO"` | Minimum level to log. |
+| `app_name` | `None` | App name for the log file path. When set, file logging is enabled by default. |
+| `file` | `None` | Explicitly enable (`True`) or disable (`False`) file logging, regardless of `app_name`. |
+
+Call this **once** at startup. Subsequent calls are no-ops.
+
+### `get_logger`
+
+```python
+logger = get_logger()
+logger = get_logger(request_id="abc123", user_id=42)
+```
+
+Returns a Loguru logger bound with optional key-value context. The context is included in every message emitted through that logger instance.
+
+## Multiline messages
+
+Continuation lines are automatically indented to align with the first line:
+
+```python
+logger.info("Query returned 3 rows:\nrow1\nrow2\nrow3")
+```
+
+```
+2026-05-11 14:32:01 | INFO     | myapp:run:10                              | Query returned 3 rows:
+                                                                            | row1
+                                                                            | row2
+                                                                            | row3
+```
+
+## License
+
+MIT

small_logger-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+small_logger/__init__.py,sha256=nB0WBqgTC7on90iiqiwTwry0_RSd61LRZwKuWkTOmBg,88
+small_logger/core.py,sha256=GttMKdYFuGNBoV4HGw1k_Jab-4hItABN7poV5a5a6uA,4232
+small_logger/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+small_logger-0.1.0.dist-info/licenses/LICENSE,sha256=jgOQWWOyZiJFG8HDKr6rj03SBzi3ElAQDuoOPk5DUqw,1074
+small_logger-0.1.0.dist-info/METADATA,sha256=vU-J31sHQArBaLtbhypRU7B9TaNSptFRBADNAONFWgY,4400
+small_logger-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+small_logger-0.1.0.dist-info/top_level.txt,sha256=BWmRBTX0lyUBOTTeq6WVVntzQ29YUKlpwwpyOWDCBT4,13
+small_logger-0.1.0.dist-info/RECORD,,

small_logger-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

small_logger-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Seppe Van Bogaert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

small_logger-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+small_logger