auro-utils 0.0.6

Auro Utils is a utility package offering various practical supports for the Auromix application, such as enhanced logging capabilities and more.

auro_utils

Auro Utils is a utility toolkit, providing enhanced logging, performance profiling, etc.

Install

Install from pip

pip install auro_utils

Install from source

git clone https://github.com/Auromix/auro_utils
cd auro_utils
pip install -e .

Test

cd auro_utils
python3 -m pytest -v .

Usage

Following are some simplified examples of utilities offered by this package.

You can also find detailed examples in the examples folder.

cd auro_utils/examples

Loggers

logger

Logger is a class that can be used to log messages to the console and to a file. It is a wrapper around loguru.

from auro_utils.loggers.logger import Logger
my_logger = Logger()
my_logger.log_info("This is a info log test.")

classic logger

Classic logger is a class that can be used to log messages to the console and to a file. It is a wrapper around the standard python logging module.

from auro_utils.loggers.logger_classic import Logger
my_logger = Logger()
my_logger.log_info("This is a info log test.")

Profilers

profiler

Decorator for profiling and analyzing performance of functions. It is a wrapper around yappi.

from auro_utils.profilers.profiler import auro_profiler
@auro_profiler
def your_function_code():
    import time
    time.sleep(2)

IO

file_operator

Functions in file_operator can be used to read and write files and process paths.

# Get the project top level directory
from auro_utils.io.file_operator import get_project_top_level_dir
project_top_dir=get_project_top_level_dir()
print(project_top_dir)

# Read a toml file
from auro_utils.io.file_operator import read_toml
config = read_toml(project_top_dir+ "/config.toml")
print(config)

Install

pip install auro_utils

Troubleshooting

ModuleNotFoundError

Make sure you have installed the package correctly. See Install section.

Want to uninstall

pip uninstall auro_utils

Contribute

Please refer to CONTRIBUTING.md for more information.