Configure pre-commit for project (#346)

This commit is contained in:
Arun Babu Neelicattu 2022-03-03 19:10:01 +01:00 committed by GitHub
parent bd69862a02
commit a836fb23bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 1733 additions and 16 deletions

View File

@ -16,7 +16,7 @@ jobs:
fail-fast: false
matrix:
os: [Ubuntu, MacOS, Windows]
python-version: ['3.6.7', '3.7', '3.8', '3.9', '3.10']
python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
exclude:
- os: Windows
python-version: 3.6
@ -57,7 +57,7 @@ jobs:
- name: Install dependencies
shell: bash
run: poetry install
run: poetry install -E compiler
- name: Generate code from proto files
shell: bash

View File

@ -14,13 +14,5 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run Black
uses: lgeiger/black-action@master
with:
args: --check src/ tests/ benchmarks/
- name: Install rST dependcies
run: python -m pip install doc8
- name: Lint documentation for errors
run: python -m doc8 docs --max-line-length 88 --ignore-path-errors "docs/migrating.rst;D001"
# it has a table which is longer than 88 characters long
- uses: actions/setup-python@v2
- uses: pre-commit/action@v2.0.3

15
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,15 @@
ci:
autofix_prs: false
repos:
- repo: https://github.com/psf/black
rev: 22.1.0
hooks:
- id: black
- repo: https://github.com/PyCQA/doc8
rev: 0.10.1
hooks:
- id: doc8
additional_dependencies:
- toml

View File

@ -381,8 +381,7 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc)
```sh
# Get set up with the virtual env & dependencies
poetry run pip install --upgrade pip
poetry install
poetry install -E compiler
# Activate the poetry environment
poetry shell

1702
poetry.lock generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -21,7 +21,6 @@ python-dateutil = "^2.8"
[tool.poetry.dev-dependencies]
asv = "^0.4.2"
black = "^21.11b0"
bpython = "^0.19"
grpcio-tools = "^1.40.0"
jinja2 = ">=2.11.2"
@ -36,6 +35,7 @@ sphinx = "3.1.2"
sphinx-rtd-theme = "0.5.0"
tomlkit = "^0.7.0"
tox = "^3.15.1"
pre-commit = "^2.17.0"
[tool.poetry.scripts]
@ -97,13 +97,22 @@ shell = "poe generate && tox"
help = "Run tests with multiple pythons"
[tool.poe.tasks.check-style]
cmd = "black . --check --diff --exclude tests/output_"
cmd = "black . --check --diff"
help = "Check if code style is correct"
[tool.black]
target-version = ['py36']
[tool.doc8]
paths = ["docs"]
max_line_length = 88
[tool.doc8.ignore_path_errors]
"docs/migrating.rst" = [
"D001", # contains table which is longer than 88 characters long
]
[tool.coverage.run]
omit = ["betterproto/tests/*"]