Metadata-Version: 2.4
Name: envoy.code.check
Version: 0.6.3
Summary: Code checker used in Envoy proxy CI
Home-page: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
Author: Ryan Northey
Author-email: ryan@synca.io
Maintainer: Ryan Northey
Maintainer-email: ryan@synca.io
License: Apache Software License 2.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: abstracts>=0.2.0
Requires-Dist: aio.core>=0.11.1
Requires-Dist: aio.run.checker>=0.6.1
Requires-Dist: envoy.base.utils>=0.6.3
Requires-Dist: flake8>=6.1.0
Requires-Dist: packaging>=23.0
Requires-Dist: pep8-naming>=0.13.3
Requires-Dist: yamllint>=1.32.0
Requires-Dist: yapf>=0.40.2
Provides-Extra: test
Requires-Dist: pytest>=7.4.0; extra == "test"
Requires-Dist: pytest-asyncio>=0.23.3; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-iters>=0.1.0; extra == "test"
Requires-Dist: pytest-patches>=0.1.0; extra == "test"
Provides-Extra: lint
Requires-Dist: flake8>=6.1.0; extra == "lint"
Provides-Extra: types
Requires-Dist: mypy>=1.6.0; extra == "types"
Requires-Dist: mypy-abstracts>=0.1.1; extra == "types"
Requires-Dist: types-pyyaml; extra == "types"
Provides-Extra: publish
Requires-Dist: wheel>=0.41.0; extra == "publish"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


envoy.code.check
================

Code checker used in Envoy proxy's CI.

This package provides an async checker that runs source-code checks against an
Envoy (or Envoy-like) checkout. Registered checks include:

- ``python_flake8`` and ``python_yapf`` for Python style
- ``yamllint`` for YAML files
- ``shellcheck`` for shell scripts
- ``glint`` for file hygiene checks
- ``gofmt`` for Go formatting
- ``runtime_guards`` consistency checks
- extension metadata, registration, owner, and fuzz-coverage checks
- changelog validation, including RST sanity checks

Usage
-----

Installed as a console script:

.. code-block:: console

   $ envoy.code.check --help

Run a subset of checks against a checkout:

.. code-block:: console

   $ envoy.code.check --check python_flake8 python_yapf --path /path/to/envoy

Run only against files changed since a given ref:

.. code-block:: console

   $ envoy.code.check --since main --path /path/to/envoy

See ``envoy.code.check --help`` for the full set of options.

Links
-----

- Source: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
- Issues: https://github.com/envoyproxy/toolshed/issues
