This repository contains a small Python package designed to simplify the process of enabling consistent logging across multiple projects. Instead of copying code from one project to another, this package provides a simple, reusable solution.
This repository is a fork of fl-logging-base.
The original repository was archived along with all other federated learning components.
This repository is now maintained independently — all future updates, bug fixes,
and extensions will be published here.
This README.md is primarily intended for developers and contributors, providing necessary information for setup, installation, and contribution guidelines. If you're interested in using or testing this project, we recommend starting with the GitHub pages. They offer a more user-friendly interface and comprehensive guides to get you started.
The repository is organized as follows:
- docs: Markdown-based user documentation published on the GitLab Pages.
- examples: Logging configuration file examples.
- LICENSES: All license files used somewhere in this project. Also see LICENSE.md.
- scripts: Scripts extending this project.
- src: Project source code.
- Python 3.11 or later
- uv
For developer it is recommended to install all dependency groups.
uv sync --all-groupsPlease follow the contribution rules:
- use typed Python (type annotations)
- verify Python static code checks with ruff
- document fixes, enhancements, new features, ...
- write scripts and examples OS independent or at least with linux, wsl support
- verify shell script static code check compliance with ShellCheck
- verify REUSE Specification 3.0 compliance for all files
- verify project license compliance without any license conflicts (e.g. for 3rd party libraries, data, models, ...)
- verify documentation (markdown) compliance w.r.t. markdown linting rules further specified inside the .markdownlint-cli2.jsonc configuration file
- run all tests successfully
This projects is using the Docstring style from Google. At least public classes, methods, fields, ... should be documented.
For further documentation we are using Markdown documentation with Material for MkDocs. See the docs folder for more details.
To locally serve the documentation, feel free to use:
uv run mkdocs serve
For accurate citation, refer to the corresponding metadata in the CITATION.cff file associated with this work.
Please see the file LICENSE.md for further information about how the content is licensed.