Metadata-Version: 2.1
Name: lg-linter
Version: 0.1.9
Summary: A pre commit linter for cpp, python and sh.
Home-page: https://github.com/lgulich/lg-linter
Author: Lionel Gulich
Author-email: lgulich@ethz.ch
License: GPL-3.0
Download-URL: https://github.com/lgulich/lg-linter/archive/v0.1.8.tar.gz
Description: # LG-Linter
        ![Upload Python Package](https://github.com/lgulich/lg-linter/workflows/Upload%20Python%20Package/badge.svg?branch=master)
        
        A simple pre-commit linter for bash, python and c++.
        
        ## Installation
        Make sure you have `clang-format` and `shellcheck` installed. If not you can install them with
        ```sh
        sudo apt update
        sudo apt install -y clang-format shellcheck
        ```
        Next install the linter with
        ```sh
        pip3 install lg-linter
        ```
        **Note:** This will install / overwrite the linter config files in your home directory.
        
        ## How to use
        Inside your git repo run
        ```sh
        init_lg_linter
        ```
        The linter is now active and will be run before every commit.
        If you want to remove the linter from your repo use
        ```
        deinit_lg_linter
        ```
        
        **Pro Tip:** If the linter complains about stuff which clearly is wrong you can override him with
        ```
        git commit --no-verify
        ```
        Use with care, with great power comes great responsibility!
        
        ## Contact
        For feature requests or bug reports please drop an issue at https://github.com/lgulich/lg-linter.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/markdown
