Metadata-Version: 2.4
Name: project-logging
Version: 0.1.0
Summary: Lightweight utility for structured logging with automatic log and graph directory management
Author: Cormac Everard
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file


# project-logging

Lightweight Python utility for structured logging with automatic log and graph directory management.

---

## Features

- Simple logging setup with file + console output
- Automatic creation of log directories
- Dedicated folder for saving graphs or outputs
- Clean, reusable API for projects and analysis pipelines

---

## Installation

Install from PyPI:

    pip install project-logging

---

## Usage and Configuration

    from project_logging import Logger

    # Initialize logger with default settings
    logger = Logger().setup_logging(log_filename="analysis.log")

    # Log messages
    logger.info("Starting analysis")
    logger.warning("This is a warning")

    # Access graph output directory
    print(logger.graph_save_path)

    # Custom configuration
    logger = Logger().setup_logging(
        main_log_folder="_LOGS",
        log_filename="experiment.log",
        log_folder="run_01",
        graphs_folder="plots"
    )

---

## Output structure

    _LOGS/
        experiment/
            experiment.log
            experiment_graphs/

---

## License

This project is licensed under the MIT License.
``
