diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 13309cca..94b4a4cb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,8 +1,7 @@ -**WARNING:** Please do not report issues about missing Django, see +**WARNING:** Please do not report issues about missing Django, see [README](https://github.com/PyCQA/pylint-django#installation)! **TODO:** make sure to post the output of `pip freeze` -**NOTES:** make sure you have the latest version of 3rd party packages -like `rest_framework`, `factory`, `model_utils`, etc. before reporting -issues! +**NOTES:** make sure you have the latest version of 3rd party packages like +`rest_framework`, `factory`, `model_utils`, etc. before reporting issues! diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 840aa95b..c86de4f9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,16 +24,17 @@ jobs: - name: Execute tests run: | - pip install -U pip poetry tox - poetry install - - export TOXENV=${{ matrix.toxenv }} - export PYTHON=${{ matrix.python-version }} - tox + pip install -U pip poetry tox + poetry install + export TOXENV=${{ matrix.toxenv }} + export PYTHON=${{ matrix.python-version }} + tox test: - name: test latest / Django@${{ matrix.django-version }} / Python@${{ matrix.python-version }} + name: + test latest / Django@${{ matrix.django-version }} / Python@${{ + matrix.python-version }} runs-on: ubuntu-latest strategy: fail-fast: false @@ -50,26 +51,28 @@ jobs: - name: Execute tests run: | - pip install -U pip poetry tox - poetry install + pip install -U pip poetry tox + poetry install - export DJANGO=${{ matrix.django-version }} - export PYTHON=${{ matrix.python-version }} - export TOXENV=$(echo py${{ matrix.python-version }}-django${{ matrix.django-version }} | tr -d .) - tox + export DJANGO=${{ matrix.django-version }} + export PYTHON=${{ matrix.python-version }} + export TOXENV=$(echo py${{ matrix.python-version }}-django${{ matrix.django-version }} | tr -d .) + tox - name: Coveralls env: COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | - pip install coveralls - coveralls --service=github + pip install coveralls + coveralls --service=github - test_deprecated: # testing older versions of python+django - name: test old stuff / Django@${{ matrix.django-version }} / Python@${{ matrix.python-version }} + test_deprecated: # testing older versions of python+django + name: + test old stuff / Django@${{ matrix.django-version }} / Python@${{ + matrix.python-version }} runs-on: ubuntu-latest - strategy: # TODO: use a YAML anchor - not supported in GitHub actions "yet" + strategy: # TODO: use a YAML anchor - not supported in GitHub actions "yet" fail-fast: false matrix: python-version: [3.7, 3.8, 3.9] @@ -84,21 +87,21 @@ jobs: - name: Execute tests run: | - pip install -U pip poetry tox - poetry install + pip install -U pip poetry tox + poetry install - export DJANGO=${{ matrix.django-version }} - export PYTHON=${{ matrix.python-version }} - export TOXENV=$(echo py${{ matrix.python-version }}-django${{ matrix.django-version }} | tr -d .) - tox + export DJANGO=${{ matrix.django-version }} + export PYTHON=${{ matrix.python-version }} + export TOXENV=$(echo py${{ matrix.python-version }}-django${{ matrix.django-version }} | tr -d .) + tox - name: Coveralls env: COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | - pip install coveralls - coveralls --service=github + pip install coveralls + coveralls --service=github build_and_package_sanity: runs-on: ubuntu-latest @@ -115,6 +118,6 @@ jobs: - name: Build run: | - pip install -U pip poetry tox - poetry install - ./scripts/build.sh + pip install -U pip poetry tox + poetry install + ./scripts/build.sh diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index cf941205..9ad308e7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,12 +10,11 @@ repos: - id: mixed-line-ending args: [--fix=lf] - id: debug-statements - # code formatting - repo: https://github.com/PyCQA/flake8 rev: 6.1.0 hooks: - id: flake8 - args: [ --max-line-length=120 ] + args: [--max-line-length=120] - repo: https://github.com/psf/black rev: 23.10.1 hooks: @@ -25,7 +24,12 @@ repos: rev: 5.12.0 hooks: - id: isort - args: ['--profile', 'black'] + args: ["--profile", "black"] + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v3.0.3 + hooks: + - id: prettier + args: [--prose-wrap=always, --print-width=88] - repo: local hooks: - id: pylint diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 07160217..a35d2755 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,22 +1,22 @@ -* [carlio](https://github.com/carlio) -* [mbarrien](https://github.com/mbarrien) -* [frost-nzcr4](https://github.com/frost-nzcr4) -* [ustun](https://github.com/ustun) -* [jproffitt](https://github.com/jproffitt) -* [lhupfeldt](https://github.com/lhupfeldt) -* [smirolo](https://github.com/smirolo) -* [mbertolacci](https://github.com/mbertolacci) -* [atodorov](https://github.com/atodorov) -* [bittner](https://github.com/bittner) -* [federicobond](https://github.com/federicobond) -* [matusvalo](https://github.com/matusvalo) -* [fadedDexofan](https://github.com/fadeddexofan) -* [imomaliev](https://github.com/imomaliev) -* [psrb](https://github.com/psrb) -* [WayneLambert](https://github.com/WayneLambert) -* [alejandro-angulo](https://github.com/alejandro-angulo) -* [brymut](https://github.com/brymut) -* [michael-k](https://github.com/michael-k) -* [naquiroz](https://github.com/naquiroz) -* [john-sandall](https://github.com/john-sandall) -* [dineshtrivedi](https://github.com/dineshtrivedi) +- [carlio](https://github.com/carlio) +- [mbarrien](https://github.com/mbarrien) +- [frost-nzcr4](https://github.com/frost-nzcr4) +- [ustun](https://github.com/ustun) +- [jproffitt](https://github.com/jproffitt) +- [lhupfeldt](https://github.com/lhupfeldt) +- [smirolo](https://github.com/smirolo) +- [mbertolacci](https://github.com/mbertolacci) +- [atodorov](https://github.com/atodorov) +- [bittner](https://github.com/bittner) +- [federicobond](https://github.com/federicobond) +- [matusvalo](https://github.com/matusvalo) +- [fadedDexofan](https://github.com/fadeddexofan) +- [imomaliev](https://github.com/imomaliev) +- [psrb](https://github.com/psrb) +- [WayneLambert](https://github.com/WayneLambert) +- [alejandro-angulo](https://github.com/alejandro-angulo) +- [brymut](https://github.com/brymut) +- [michael-k](https://github.com/michael-k) +- [naquiroz](https://github.com/naquiroz) +- [john-sandall](https://github.com/john-sandall) +- [dineshtrivedi](https://github.com/dineshtrivedi) diff --git a/SECURITY.md b/SECURITY.md index 41f6aa46..c2a303fe 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,13 +2,13 @@ ## Supported Versions -| Version | Supported | -| ------- | ------------------ | +| Version | Supported | +| ------------------------------------------------- | ------------------ | | [latest](https://pypi.org/project/pylint-django/) | :heavy_check_mark: | ## Reporting a Vulnerability -In case you have found a security problem with pylint-django *DO NOT* report -it into GitHub Issues. Instead go to -[https://tidelift.com/security](https://tidelift.com/security) -and follow the instructions there. +In case you have found a security problem with pylint-django _DO NOT_ report it into +GitHub Issues. Instead go to +[https://tidelift.com/security](https://tidelift.com/security) and follow the +instructions there.