diagnosticism 0.12.0

Basic diagnostic facilities, for Python

Diagnosticism.Python

Diagnosticism library, for Python

Table of Contents

• Introduction
• Installation & usage
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
  • Related projects
  • License

Introduction

Diagnosticism is a standalone library of simple components for aiding in diagnostics for Python projects. It contains versions of components seen in the other Diagnosticisms - see below - though there is not a 1-to-1 correspondence between any of them.

Installation & usage

Install via pip or pip3, as in:

$ pip3 install diagnosticism

Use via import:

import diagnosticism

When using the simple logging facilities, we find it convenient to import as follows:

import diagnosticism as d
import diagnosticism.severity as sev

that may then be used as:

d.log(sev.INFO, "hello")

Components

Diagnosticism.Python provides components in the following categories:

• Contingent Reporting
• Diagnostic Logging
• Tracing

NOTE: for the moment, the Diagnostic Logging facilities emit to the standard error stream, via the Contingent Reporting API. In the near future this will be changed to work with more sophisticated logging libraries, including the standard logging facilities and the (as yet to be release) Pantheios.Python.

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/Diagnosticism.Python.

Dependencies

Related projects

• Diagnosticism
• Diagnosticism.Go
• Diagnosticism.NET

License

Diagnosticism.Python is released under the 3-clause BSD license. See LICENSE for details.