Skip to content

Commit

Permalink
doc: Added documentation for python support
Browse files Browse the repository at this point in the history
In yoheimuta#338 Python support is requested. Documentation has been added.
  • Loading branch information
carstencodes committed Dec 18, 2023
1 parent a040b98 commit 7f5019c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,16 @@ You can add a `protolint` node to your `package.json` which may contain the cont

If you want to get an output that matches the TSC compiler, use reporter `tsc`.

### Within Python projects

You can use `protolint` as a linter within your python projects. Just add the desired version to
your `pyproject.toml` or `requirements.txt`.

The wheels downloaded will contain the compiled go binaries for `protolint` and `protoc-gen-protolint`. Your platform must
be compatible with the supported binary platforms.

You can add the linter configuration to the `tools.protolint` package in `pyproject.toml`.

## Usage

```sh
Expand Down

0 comments on commit 7f5019c

Please sign in to comment.