Skip to main content


Project description


Build Status

The logging-toolbox module contains useful functions to help the user with logging recurring things like command-line arguments and dependencies on startup.


Logging program arguments and dependencies

Suppose we have a Python program that has the dependencies dep1 and dep2, and takes the command-line arguments --server-url, --one-argument and --some-hex-value. We'll assume the module the program is a part of is called simple_program. Upon startup, we can log the versions of our dependencies and all arguments.

from .utils import get_args, setup_logging

from logging_toolbox.startup import startup_log
from logging_toolbox.utils import clean_url

if __name__ == '__main__':
    arguments = get_args()

                critical_modules=['simple_program', 'dep1', 'dep2'],
                cleaners={'server_url': clean_url,
                          'some_hex_value': '0x{:04X}'.format})

This should log something like:

simple_program : UNKNOWN
dep1           : 0.3.2.dev23
dep2           : 1.0.1
one_argument   : argument value
server_url     : https://user:******@server/
some_hex_value : 0x02FF

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logging-toolbox-0.2.0.tar.gz (4.6 kB view hashes)

Uploaded source

Built Distribution

logging_toolbox-0.2.0-py2.py3-none-any.whl (6.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page