betternom is a Python utility designed to enhance the output of the norminette by adding colorization to its output, making it easier to distinguish between various types of messages such as errors and successful checks. It utilizes colorama for terminal color output and provides additional functionality such as minimizing output and showing errors only.
- Colorized Output: Makes it easier to read norminette outputs by color-coding messages.
- Minimize Output: Option to show a minimized version of the output for a quicker overview.
- Error Only Mode: Can be configured to show only errors, omitting the OK messages for cleaner output.
- Summary View: Provides a summary of the norminette run, including counts of files checked, errors found, etc.
Want another feature ? Ask it to me !
Before installing betternom, ensure you have Python installed on your system. betternom requires Python 3.6 or newer.
To install betternom directly from the GitLab repository:
- Clone the repository:
git clone https://gitlab.com/theo_vdml/betternorm- Navigate to the cloned directory:
cd betternom- Install the package:
pip3 install .- If you face an error with permission (at school for example) try with the --user params
pip3 install . --userThis method is useful if you want to install the most recent changes that may not yet be published on PyPI.
To use betternom, run the following command in your terminal:
betternorm [filename] [options]Options include:
-e,--error-onlyto display only errors.-m,--minimizefor minimized output.-s,--summary-onlyto display only the summary.-a,--argsto pass additional arguments to norminette. (will take the rest of the command line and pass it to norminette)
For detailed help and more options, run:
betternorm --helpWe welcome contributions! If you would like to contribute to the project, please fork the repository, make your changes, and submit a merge request on GitLab.
betternom is open-source software licensed under the MIT license.