Metadata-Version: 2.1
Name: pymultilint
Version: 0.1.5
Summary: Utility tying multiple code quality tools together
Home-page: https://github.com/gkze/multilint
License: MIT
Keywords: lint,code-quality,tools
Author: George Kontridze
Author-email: george.kontridze@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: autoflake (==1.4)
Requires-Dist: black (==20.8b1)
Requires-Dist: click (==7.1.2)
Requires-Dist: invoke (>=1.5.0,<2.0.0)
Requires-Dist: isort (==5.7.0)
Requires-Dist: jedi (==0.17.2)
Requires-Dist: mypy (==0.800)
Requires-Dist: parso (==0.7.1)
Requires-Dist: pydocstyle (>=5.1.1,<6.0.0)
Requires-Dist: pylint (>=2.6.0,<3.0.0)
Requires-Dist: toml (==0.10.2)
Project-URL: Documentation, https://gkze.github.io/multilint/multilint.html
Project-URL: Repository, https://github.com/gkze/multilint
Description-Content-Type: text/markdown

# Multilint (for Python)

[![Actions Test Workflow Widget](https://github.com/gkze/multilint/workflows/ci/badge.svg)](https://github.com/gkze/multilint/actions?query=workflow%3Aci)
[![PyPI Version](https://img.shields.io/pypi/v/pymultilint)](https://pypi.org/project/pymultilint/)
[![Pdoc Documentation](https://img.shields.io/badge/pdoc-docs-green)](https://gkze.github.io/multilint/multilint.html)

A utility tying together multiple linting and other code quality tools

Multilint allows running several code quality tools under the same interface.
This is convenient as it saves time on writing multiple linter / formatter /
checker invocations every time in a project.

Additionally, for tools that do
not currently support configuration via `pyproject.toml`
([PEP-621](https://www.python.org/dev/peps/pep-0621/)), Multilint exposes a
configuration interface for them. This allows for centralized codification of
configuration of all code quality tools being used in a project.

Example relevant sections from a `pyproject.toml`:

```toml
[tool.autoflake]
recursive = true
in_place = true
ignore_init_module_imports = true
remove_all_unused_imports = true
remove_unused_variables = true
verbose = true
srcs = ["."]

[tool.mypy]
src = "."

[tool.multilint]
tool_order = ["autoflake", "isort", "black", "mypy"]
```

Currently, the only supported configuration option for Multilint is
`tool_order` which defines the execution order of supported tools.

At the time of writing of this README (2020-01-31), neither
[Autoflake](https://github.com/myint/autoflake/issues/59) nor
[Mypy](https://github.com/python/mypy/issues/5205https://github.com/python/mypy/issues/5205)
support configuration via `pyproject.toml`. While support for each may or may
not be added at some point in the future, with multilint configuring these tools
is possible **today**.

## Supported Tools

* [Autoflake](https://github.com/myint/autoflake) - removes unused imports and
  unused variables as identified by [Pyflakes](https://github.com/PyCQA/pyflakes)
* [Isort](https://pycqa.github.io/isort/) - sorts imports according to specified
  orders
* [Black](https://black.readthedocs.io/en/stable/) - the self-proclaimed
  "uncompromising code formatter" - formats Python source with an opinionated
  style
* [Mypy](http://mypy-lang.org) - static type checker for Python
* [Pylint](https://www.pylint.org) - general best practices linter
* [Pydocstyle](http://www.pydocstyle.org/en/stable/) - in-source documentation
  best practices linter

Support for more tools may be added by subclassing the
[`ToolRunner`](multilint.py#L127) class and overriding the
[`.run(...)`](multilint.py#L159) method.

There are some utilities provided, such as:

* A logger that masquerades as a TextIO object to allow capturing tool output
  from within and a configuration
* A mapping for tool configuration that is automatically available in the
  `ToolRunner` class (as long as it is registered in the
  [`Tool`](multilint.py#L47)) enum, the [`TOOL_RUNNERS`](multilint.py#L437)
  mapping, and declared in the [`DEFAULT_TOOL_ORDER`](multilint.py#L456) class
  variable of `Multilint`.

Documentation about adding support for more tools to Multilint may be added in
the future.

