Skip to main content

Shared utilities for logging and configuration management

Project description

Spello Consulting Utility Library

A Python utility library for log file management and YAML configuration file management

Details to follow

Example code

from config_schemas import ConfigSchema
from sc_config_mgr import SCConfigManager
from sc_logging import SCLogger

CONFIG_FILE = "config.yaml"


def main():
    print("Hello from sc-utility!")

    # Get our default schema, validation schema, and placeholders
    schemas = ConfigSchema()

    # Initialize the SC_ConfigManager class
    config = SCConfigManager(
        config_file=CONFIG_FILE,
        default_config=schemas.default,  # Replace with your default config if needed
        validation_schema=schemas.validation,  # Replace with your validation schema if needed
        placeholders=schemas.placeholders  # Replace with your placeholders if needed
    )

    config_value = config.get("AmberAPI", "APIKey", default="this is the default value")
    if config_value is None:
        print("Configuration value not found")
    else:
        print(f"Configuration loaded successfully. Sample value: {config_value}")

    # Initialize the SC_Logger class
    logger = SCLogger(config.get_logger_settings())

    logger.log_message("This is a test message at the debug level.", "debug")
    # logger.log_message("This is a test message at the error level.", "error")

    # Setup email
    email_settings = config.get_email_settings()
    logger.register_email_settings(email_settings)

    if logger.send_email("Hello world", "This is a test email from the sc-utility test harness."):
        logger.log_message("Email sent OK.", "detailed")

    if logger.get_fatal_error():
        print("Prior fatal error detected.")
        logger.clear_fatal_error()

    # logger.log_fatal_error("This is a test fatal error message.")

    logger.clear_fatal_error()

if __name__ == "__main__":
    main()

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

sc_utility-0.1.0.tar.gz (2.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sc_utility-0.1.0-py3-none-any.whl (2.7 kB view details)

Uploaded Python 3

File details

Details for the file sc_utility-0.1.0.tar.gz.

File metadata

  • Download URL: sc_utility-0.1.0.tar.gz
  • Upload date:
  • Size: 2.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sc_utility-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d384dddf3bb342ae2ef21a035cc521574781b193ea6d67ba275d8632a9947198
MD5 9adc475938fbb29bf7d383d6a22ca8c2
BLAKE2b-256 750f94c59b28d0944fb8de4c4bbbfc3458011823a7c45e811d5958c091d2492d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sc_utility-0.1.0.tar.gz:

Publisher: publish.yml on NickElseySpelloC/sc_utility

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sc_utility-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sc_utility-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sc_utility-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f422bfebccfa63cd55864b3c138d00c25ff87c59afdf0caf0414a1e6a53cd28a
MD5 8af6c05b00b9d0efab5ec33d92c14be0
BLAKE2b-256 4b64d4313af0f24b5e6ef63f78ddec41875413e3cc83528004049c885d3efb26

See more details on using hashes here.

Provenance

The following attestation bundles were made for sc_utility-0.1.0-py3-none-any.whl:

Publisher: publish.yml on NickElseySpelloC/sc_utility

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page