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.10.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.10-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: skilleter_readable-0.0.10.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.10.tar.gz
Algorithm Hash digest
SHA256 4b92bcf5e905cbd1f0a8573a15eb28dd4b3ffd5dd9be93518b57b5bdec1aaa2f
MD5 f4413270f38546dc84a71d2eb856bdd1
BLAKE2b-256 3c350c22dc91930cb557302f7d7c997fadd82e353905e7285a369b95f5a1bdf6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for skilleter_readable-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 10760dada6268c48524544993a99032baf95c77e98a1f213325218e029ffe871
MD5 9ea56021c4f82737f6019e7ce5369194
BLAKE2b-256 34bb0f2bce3f8dd578fe0a569d5635599b45a0b968fbf6838fd5a30c803a5a6b

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