prospector.yaml

strictness: high
test-warnings: false
doc-warnings: true
member-warnings: true

ignore-paths:
  - .eggs
  - .tox
  - benchmark
  - build
  - docs
  - examples
  - readme
  - tests
  - my_tests
  - venv

ignore-patterns:
  - setup.py
  - _version.py

# pylint configuration
pylint:
  disable:
    - invalid-name
    - missing-module-docstring
    - too-many-lines
    - ungrouped-imports
  options:
    max-line-length: 120

# pyflakes configuration
pyflakes:
  disable:
    - F401    # imported but not used

# mypy configuration
mypy:
  run: true
  options:
    ignore-missing-imports: true
    follow-imports: skip

# pyroma configuration
pyroma:
  run: true

# pydocstyle (old pep257) configuration
pydocstyle:
  disable:
    - D104    # Missing docstring in public package
    - D202    # No blank lines allowed after function docstring
    - D203    # 1 blank line required before class docstring
    - D205    # 1 blank line required between summary line and description
    - D212    # Multi-line docstring summary should start at the first line
    - D406    # Section name should end with a newline
    - D407    # Missing dashed underline after section
    - D413    # Missing blank line after last section

# pycodestyle (old pep8) configuration
pycodestyle:
  disable:
    - N802    # function name should be lowercase
  options:
    max-line-length: 120