pyproject.toml

[tool.poetry]
name = "docformatter"
version = "1.7.5"
description = "Formats docstrings to follow PEP 257"
authors = ["Steven Myint"]
maintainers = [
    "Doyle Rowland <doyle.rowland@reliaqual.com>",
]
license = "Expat"
readme = "README.rst"
homepage = "https://github.com/PyCQA/docformatter"
repository = "https://github.com/PyCQA/docformatter"
documentation = "https://docformatter.readthedocs.io/en/latest/"
keywords = [
    "PEP 257", "pep257", "style", "formatter", "docstrings",
]
classifiers=[
          'Intended Audience :: Developers',
          'Environment :: Console',
          'Programming Language :: Python :: 3',
          'Programming Language :: Python :: 3.7',
          'Programming Language :: Python :: 3.8',
          'Programming Language :: Python :: 3.9',
          'Programming Language :: Python :: 3.10',
          'Programming Language :: Python :: 3.11',
          'Programming Language :: Python :: Implementation',
          'Programming Language :: Python :: Implementation :: PyPy',
          'Programming Language :: Python :: Implementation :: CPython',
          'License :: OSI Approved :: MIT License',
      ]
packages = [{include = "docformatter", from = "src"}]
include = ["LICENSE"]

[tool.poetry.dependencies]
python = "^3.7"
charset_normalizer = "^3.0.0"
tomli = {version = "^2.0.0", python = "<3.11", optional = true}
untokenize = "^0.1.1"

[tool.poetry.dev-dependencies]
autopep8 = "^2.0.0"
black = "^22.0.0"
coverage = {extras = ["toml"], version = "^6.4.0"}
isort = "^5.10.0"
mock = "^4.0.0"
mypy = "0.991"
pycodestyle = "^2.8.0"
pydocstyle = "^6.1.1"
pylint = [
    {version = "^2.12.0", python = "<3.7.2"},
    {version = "^2.14.0", python = ">=3.7.2"},
]
pytest = "^7.1.0"
pytest-cov = "^4.0.0"
ruff = "^0.0.267"
rstcheck = "^6.1.0"
tox = "<4.0.0"
Sphinx = [
    {version = "5.3.0", python = "<3.8"},
    {version = "^6.0.0", python = ">=3.8"},
]
twine = "^4.0.0"

[tool.poetry.extras]
tomli = ["tomli"]

[tool.poetry.scripts]
docformatter = "docformatter.__main__:main"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.pylint.master]
ignore-paths = [
    "tests*",
]

[tool.pylint.messages_control]
disable = [
    "fixme",
    "import-outside-toplevel",
    "inconsistent-return-statements",
    "invalid-name",
    "no-else-return",
    "no-member",
    "too-few-public-methods",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-locals",
    "too-many-return-statements",
    "useless-object-inheritance",
]

[tool.docformatter]
black = true
non-strict = false
non-cap = [
	"docformatter",
]

[tool.mypy]
allow_subclassing_any = true
follow_imports = "skip"
implicit_reexport = true
ignore_missing_imports = true

[tool.pydocstyle]
convention = "pep257"

[tool.pytest.ini_options]
markers = [
    "unit: mark the test as a unit test.",
    "system: mark the test as a system test.",
]

[tool.coverage.run]
branch = true
cover_pylib = false
omit = [
    '*/site-packages/*',
    '*/*pypy/*',
    '*/tests/*',
    '__init__.py',
    'setup.py',
]
relative_files = true

[tool.coverage.report]
omit = [
    '*/site-packages/*',
    '*/*pypy/*',
    '*/tests/*',
    '__init__.py',
    'setup.py',
]
exclude_lines = [
	'pragma: no cover',
	'import',
]
show_missing = true

[tool.coverage.xml]
output = 'coverage.xml'

[tool.black]
line-length = 88
target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
include = '\.pyi?$'
exclude = '''
/(
    \.eggs
  | \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

[tool.isort]
known_first_party = 'docformatter'
known_third_party = ['toml']
import_heading_firstparty = 'docformatter Package Imports'
import_heading_localfolder = 'docformatter Local Imports'
import_heading_stdlib = 'Standard Library Imports'
import_heading_thirdparty = 'Third Party Imports'
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
ensure_newline_before_comments = true
line_length = 88

[tool.rstcheck]
report = "warning"
ignore_directives = [
	"automodule",
	"tabularcolumns",
	"toctree",
]
ignore_roles = [
	"numref",
]

[tool.tox]
legacy_tox_ini = """
[tox]
envlist =
    py37
    py38
    py39
    py310
    py311
    pypy3
    coverage
    style
isolated_build = true
skip_missing_interpreters = true
skipsdist = true

[gh-actions]
python =
    3.7: py37
    3.8: py38
    3.9: py39
    3.10: py310
    3.11: py311
    pypy-3.8: pypy3

[testenv]
description = run the test suite using pytest under {basepython}
deps =
    charset_normalizer
    coverage[toml]
    mock
    pytest
    pytest-cov
    tomli
    untokenize
setenv =
    COVERAGE_FILE = {toxworkdir}/.coverage.{envname}
commands =
    pip install -U pip
    pip install --prefix={toxworkdir}/{envname} -e .[tomli]
    pytest -s -x -c {toxinidir}/pyproject.toml \
        -m unit \
        --cache-clear \
        --cov=docformatter \
        --cov-config={toxinidir}/pyproject.toml \
        --cov-branch \
        {toxinidir}/tests/
    pytest -s -x -c {toxinidir}/pyproject.toml \
        -m system \
        --cache-clear \
        --cov=docformatter \
        --cov-config={toxinidir}/pyproject.toml \
        --cov-branch \
        --cov-append \
        {toxinidir}/tests/

[testenv:coverage]
description = combine coverage data and create report
setenv =
    COVERAGE_FILE = {toxworkdir}/.coverage
skip_install = true
deps =
    coverage[toml]
parallel_show_output = true
commands =
    coverage combine
    coverage report -m
    coverage xml -o {toxworkdir}/coverage.xml
depends = py37, py38, py39, py310, py311, pypy3

[testenv:style]
description = run autoformatters and style checkers
deps =
    charset_normalizer
    pycodestyle
    pydocstyle
    ruff
    rstcheck
    toml
    untokenize
commands =
    pip install -U pip
    pip install .
    docformatter --black --recursive {toxinidir}/src/docformatter
    pycodestyle --exclude=.git,.tox,*.pyc,*.pyo,build,dist,*.egg-info,config,docs,locale,tests,tools --ignore=C326,C330,E121,E123,E126,E133,E203,E242,E265,E402,W503,W504 --format=pylint --max-line-length=88 {toxinidir}/src/docformatter
    pydocstyle {toxinidir}/src/docformatter
    ruff check --select "PL" --select "F" {toxinidir}/src/docformatter
    rstcheck --report-level=1 {toxinidir}/README.rst

[testenv:docs]
description = build docformatter documentation
allowlist_externals = make
changedir = docs
commands =
    make html
"""