A Python logging library
Project description
log11
A simple logging library built on top of loguru.
Features
- Modern API: Built on top of the powerful loguru library
- Flexible Configuration: Multiple output formats (text/JSON)
- Rich Formatting: Colored output, custom fields, and structured logging
- Project Root Detection: Automatic project root discovery
- Python 3.10+: Modern Python features and type hints
- Zero Configuration: Sensible defaults out of the box
Installation
pip install log11
Quick Start
Basic Usage
from log11 import get_logger
# Get the default logger
logger = get_logger()
# Log messages
logger.info("Application started")
logger.warning("This is a warning")
logger.error("Something went wrong")
Advanced Usage
from log11 import Log, TextFormatConfig
# Setup custom logging configuration
Log.clear()
Log.add_output(
name="console",
sink="logs/app.log",
data_format="json",
level="INFO",
text_format_config=TextFormatConfig(
date=True,
time=True,
level=True,
location=False,
function=True,
message=True,
extras=True
)
)
# Apply configuration and get logger
logger = Log.apply()
# Log structured data
logger.info("User action", user_id=123, action="login")
Custom Formatting
from log11 import Log, TextFormatConfig, LogColor
# Setup with custom formatting
Log.clear()
Log.add_output(
name="console",
sink="stdout",
data_format="text",
colored=True,
level="DEBUG",
text_format_config=TextFormatConfig(
date=False,
time=True,
level=True,
location=True,
function=False,
message=True,
extras=True
)
)
logger = Log.apply()
logger.debug("Debug message with details", debug_info="extra data")
API Reference
Log
The main logging configuration manager.
Log.clear(): Clear all output configurationsLog.default_setup(): Setup default console loggingLog.apply(): Apply all configured outputs and return loggerLog.add_output(name, sink, data_format, colored, level, text_format_config, replace, auto_apply, **kwargs): Add a new output configurationLog.add_level(name, number, color): Add a custom logging levelLog.set_global_level(level): Set logging level for all outputs
get_logger
get_logger(): Get a configured logger instance (sets up defaults if needed)
Configuration Classes
TextFormatConfig(date, time, level, location, function, message, extras): Configure text output formatTextFormat(config): Text formatter implementationLogColor: Color constants for stylingLogStyle: Text styling helpersLogField: Field rendering utilities
Development
Prerequisites
Install uv for modern Python dependency management:
# On Windows (PowerShell)
irm https://astral.sh/uv/install.ps1 | iex
# On macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
Installation for Development
# Clone the repository
git clone https://github.com/vincentdeneuf/log11.git
cd log11
# Install dependencies and create virtual environment
uv sync
# Activate the virtual environment (optional, uv commands work without it)
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install in development mode
uv pip install -e .
Running Tests
# Run tests with uv
uv run pytest
# Run tests with coverage
uv run pytest --cov=log11 --cov-report=html
Building the Package
# Build the package
uv build
# Build for distribution
uv build --release
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Changelog
0.1.0
- Initial release
- Built on loguru for powerful logging capabilities
- Flexible output configuration (text/JSON formats)
- Rich formatting with colors and custom fields
- Project root detection
- Python 3.10+ support with modern type hints
- Zero-configuration default setup
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
log11-0.1.2.tar.gz
(43.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
log11-0.1.2-py3-none-any.whl
(7.0 kB
view details)
File details
Details for the file log11-0.1.2.tar.gz.
File metadata
- Download URL: log11-0.1.2.tar.gz
- Upload date:
- Size: 43.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65775cd64ffc38ce1f0da78363251a1af2295e69e8570cea435f9915e7aab787
|
|
| MD5 |
1663ff7f8ca33d1f6ac5c6d275f8b0ea
|
|
| BLAKE2b-256 |
c01e1b8e3b5cfbd42037752b2187f2eeb408ffbe7b21ab8b5f09511f1e1abe58
|
File details
Details for the file log11-0.1.2-py3-none-any.whl.
File metadata
- Download URL: log11-0.1.2-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
241cc50c24a74507d404703e70636fa1fe15c79b99d29b6e71080277018eabf6
|
|
| MD5 |
2c156f3cf593edd3eb5311d621d49360
|
|
| BLAKE2b-256 |
a7d012b990fe87a30d079cfb767c1eda2e0302d3ce0b80f722aea9c6eb5c9b9f
|