Welcome to Cartorio’s documentation!

Modules:

Readme

DOI Documentation Status

1. Cartorio

A wrapper on the logging module for Python that provides a simple and easy-to-use interface for logging.

2. Contents

  • 1. Cartorio

  • 2. Contents

  • 3. Installation

  • 4. Documentation

  • 5. Usage

3. Installation

pip install cartorio

4. Documentation

https://cartorio.readthedocs.io/en/latest/

5. Usage

Consider that your project consists of two scripts:

parent.py
child/
└──  child.py

An example of these scripts are:

# parent.py

from pathlib import Path
from cartorio import fun, log

from child.child import multiply

def main()
    multiply(10, 1)

if __name__ == "__main__":
    # Instantiation of log file
    logger = log(filename=Path(__file__).resolve().stem, logs_path=Path(__file__).resolve().parent)
    # where,
    # filename (str, Path): Log file.
    # logs_path (Path): Path where the log file is saved to.
    main()
# child.py

from cartorio import fun, log

@fun
def multiply(num1, num2):
    return num1 * num2

Indices and tables