prospector.yml

strictness: low

test-warnings: false
doc-warnings: true

uses:
  - django
  - celery

ignore-paths:
  - docs/

ignore-patterns:
  - /migrations/
  - local_settings.py

pep8:
  full: true
  options:
    max-line-length: 100

pylint:
  options:
    dummy-variables-rgx: '_$|__$|dummy'
    max-line-length: 100
  disable:
    - logging-format-interpolation
    - inconsistent-return-statements

mccabe:
  run: false

pep257:
  run: true
  disable:
    - D105
    - D211
    - D104
    - D212  # Multi-line docstring summary should start at the first line
    - D107  # Missing docstring in __init__
    - D106  # Missing docstring in public nested class

    # pydocstyle
    - D403  # First word of the first line should be properly capitalized ('Github', not 'GitHub')
    - D406  # Section name should end with a newline ('Examples', not 'Examples::')
    - D407  # Missing dashed underline after section ('Examples')
    - D412  # No blank lines allowed between a section header and its content ('Examples')
    - D413  # Missing blank line after last section ('Examples')

pyflakes:
  disable:
    - F999