Skip to main content

A utility for making log files (particularly Terraform logs) more readable and comparable

Project description

readable - utility for cleaning log files

usage: readable [-h] [--light] [--dark] [--none] [--tidy] [--strip-blank] [--debug] [--out] [--dir DIR] [--aws] [--terraform] [--replace REPLACE] [--verbose]
                [--minimal] [--non-minimal]
                [files ...]

Read from standard input and write to standard output modifying ANSI colour codes en-route.

positional arguments:
  files                 The files to convert (use stdin/stout if no input files are specified)

options:
  -h, --help            show this help message and exit
  --light, -l           Modify colours for a light background (the default)
  --dark, -d            Modify colours for a dark background
  --none, -n            Remove all colour codes
  --tidy, -t            Remove colour codes and stuff that typically occurs in log files causing diffs, but is of no particular interest (e.g. SHA1 values,
                        times, dates)
  --strip-blank, -s     Strip all blank lines
  --debug, -D           Replace colours with debug information
  --out, -o             Output to standard output rather than overwriting input files
  --dir, -O DIR         Store output files in the specified directory (creating it if it doesn't exist)
  --aws, -a             Remove AWS resource IDs
  --terraform, -T       Clean Terraform plan/apply log files
  --replace, -R REPLACE
                        Additional regex replacements in the form "REGEX=REPLACEMENT"
  --verbose, -v         Output verbose status
  --minimal, -m         Remove unnecessary data from the file (e.g. Terraform progress updates (Refreshing..., Reading..., etc.))
  --non-minimal, -M     Do not remove unnecessary data from the file (e.g. Terraform progress updates (Refreshing..., Reading..., etc.))

Tests

python3 -m unittest discover -s skilleter_readable -p "test*.py"

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

skilleter_readable-0.0.9.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

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

skilleter_readable-0.0.9-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file skilleter_readable-0.0.9.tar.gz.

File metadata

  • Download URL: skilleter_readable-0.0.9.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for skilleter_readable-0.0.9.tar.gz
Algorithm Hash digest
SHA256 424fae4a7fd91a63b488d11364a41974dbf421275b3b02db0e9425ec930a21f6
MD5 96e25e69538305da4cee2d53ee4895b4
BLAKE2b-256 7befa10ac2f75c6e75949e348ac0d096a19b12be01486426fad9038566d5d323

See more details on using hashes here.

File details

Details for the file skilleter_readable-0.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for skilleter_readable-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d8a10840e0f5c5e68325e4d4f3176a65dbdc15cb27d4bd5b4217e90a77ae40c5
MD5 4e48e75e6ce08fdc28694fda538dfb25
BLAKE2b-256 f58914f68b954ad5975d10ea75c210e25ad4dcb82abfdadcf944d77accad2220

See more details on using hashes here.

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