lintquarto 0.2.0

Package for running linters and static type checkers on quarto .qmd files.

lintquarto

Package for running linters and static type checkers on quarto .qmd files.

Currently supported linters: pylint, flake8, pyflakes, ruff, pylama, vulture, radon, and pycodestyle.

It also supports some static type checkers: mypy, pyright, pyrefly, and pytype.

Installation

You can install lintquarto from PyPI:

pip install lintquarto

To also install all supported linters:

pip install lintquarto[all]

Getting started using lintquarto

Usage

lintquarto [linter] [files or folders] [-k | --keep-temp]

• [linter] - Choose one of the supported linters: pylint, flake8, pyflakes, ruff, pylama, vulture, radon, pycodestyle, mypy, pyright, pyrefly, or pytype

• [files or folders] - One or more .qmd files or directories to lint.

• -k, --keep-temp - Keep the temporary .py files created during linting (for debugging).

Only one linter can be specified per command. Passing extra arguments directly to linters is not supported. Only .qmd files are processed.

Examples

The linter used is interchangeable in these examples.

Lint all .qmd files in the current directory (using pylint):

lintquarto pylint .

Lint a specific file (using flake8):

lintquarto flake8 file.qmd

Lint several specific files (using pylint):

lintquarto pylint file1.qmd file2.qmd

Lint all .qmd files in a folder (using mypy):

lintquarto mypy folder

Keep temporary .py files after linting (with pylint)

lintquarto pylint . -k

Community

Curious about contributing? Check out the contributing guidelines to learn how you can help. Every bit of help counts, and your contribution - no matter how minor - is highly valued.

How to cite lintquarto

Please cite the repository on GitHub, PyPI and/or Zenodo:

Heather, A. (2025). lintquarto (v0.2.0). https://github.com/lintquarto/lintquarto.

Heather, A. (2025). lintquarto (v0.2.0). https://pypi.org/project/lintquarto/

Heather, A. (2025). lintquarto (v0.2.0). https://doi.org/10.5281/zenodo.15731161.

Citation instructions are also provided in CITATION.cff.

Acknowledgements

Parts of this package were generated or adapted from code provided by Perplexity.