github.com/yoheimuta/protolint@v0.49.8-0.20240515023657-4ecaebb7575d/bdist/py/ReadMe.rst (about)

     1  protolint
     2  =========
     3  
     4  protolint is the pluggable linting/fixing utility for Protocol Buffer
     5  files (proto2+proto3)
     6  
     7  -  Runs fast because this works without compiler.
     8  -  Easy to follow the official style guide. The rules and the style
     9     guide correspond to each other exactly.
    10  
    11     -  Fixer automatically fixes all the possible official style guide
    12        violations.
    13  
    14  -  Allows to disable rules with a comment in a Protocol Buffer file.
    15  
    16     -  It is useful for projects which must keep API compatibility while
    17        enforce the style guide as much as possible.
    18     -  Some rules can be automatically disabled by inserting comments to
    19        the spotted violations.
    20  
    21  -  Loads plugins to contain your custom lint rules.
    22  -  Undergone testing for all rules.
    23  -  Many integration supports.
    24  
    25     -  protoc plugin
    26     -  Editor integration
    27     -  GitHub Action
    28     -  CI Integration
    29  
    30     .. rubric:: Usage in python projects
    31        :name: usage-in-python-projects
    32  
    33  You can use ``protolint`` as a linter within your python projects, the
    34  wheel ``protolint-bin`` on `pypi <https://pypi.org>`__ contains the
    35  pre-compiled binaries for various platforms. Just add the desired
    36  version to your ``pyproject.toml`` or ``requirements.txt``.
    37  
    38  The wheels downloaded will contain the compiled go binaries for
    39  ``protolint`` and ``protoc-gen-protolint``. Your platform must be
    40  compatible with the supported binary platforms.
    41  
    42  You can add the linter configuration to the ``tools.protolint`` package
    43  in ``pyproject.toml``.
    44  
    45  More information
    46  ----------------
    47  
    48  You will find more information on the `projects
    49  homepage <https://github.com/yoheimuta/protolint>`__.