lintquarto
Package for running linters, static type checkers and code analysis tools on python code in quarto (.qmd) files.
Science Score: 39.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.6%) to scientific vocabulary
Keywords
Repository
Package for running linters, static type checkers and code analysis tools on python code in quarto (.qmd) files.
Basic Info
- Host: GitHub
- Owner: lintquarto
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://lintquarto.github.io/lintquarto/
- Size: 1.55 MB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
- Releases: 5
Topics
Metadata Files
README.md
Package for running linters, static type checkers and code analysis tools on python code in quarto (.qmd) files.
By default, python code validation tools can't check embedded python code in Quarto files. This package fills that gap, enabling analysts and researchers to run python quality checks within Quarto documents.
Currently supported:
- Linters: pylint, flake8, pydoclint, pyflakes, ruff, vulture, and pycodestyle.
- Static type checkers: mypy, pyright, pyrefly, and pytype.
- Code analysis tools: radon.
Installation
You can install lintquarto with pip (from PyPI) or conda (from conda-forge).
Install with pip
pip install lintquarto
To include your selection of linters, install them as needed.
For a one-step installation that includes lintquarto and all supported linters and type checkers, use:
pip install lintquarto[all]
Install with conda
conda install conda-forge::lintquarto
With conda, only the main lintquarto tool is installed. If you want to use any linters or type checkers, you must install them separately (either with conda or pip, depending on availability).
Getting started using lintquarto
Usage
lintquarto -l LINTER [LINTER ...] -p PATH [PATH ...] [-e EXCLUDE [EXCLUDE ...]] [-k]
- -l --linters LINTER [LINTER ...] - Linters to run.
- -p --paths PATH [PATH ...]- Quarto files and/or directories to lint.
- -e --exclude EXCLUDE [EXCLUDE ...] - Files and/or directories to exclude from linting.
- -k, --keep-temp - Keep the temporary
.pyfiles created during linting (for debugging).
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):
{.bash}
lintquarto -l pylint -p .
Lint several specific files (using pylint and flake8):
{.bash}
lintquarto -l pylint flake8 -p file1.qmd file2.qmd
Keep temporary .py files after linting (with pylint)
{.bash}
lintquarto -l pylint -p . -k
Lint all files in current directory (using ruff):
- Excluding folders
examples/andignore/, or- - Excluding a specific file
analysis/test.qmd.
{.bash}
lintquarto -l ruff -p . -e examples,ignore
{.bash}
lintquarto -l ruff -p . -e analysis/test.qmd
Find out more
Visit our website to find out more and see examples from running with each code validation tool.
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, conda and/or Zenodo:
Heather, A. (2025). lintquarto (v0.5.0). https://github.com/lintquarto/lintquarto.
Heather, A. (2025). lintquarto (v0.5.0). https://pypi.org/project/lintquarto/.
Heather, A. (2025). lintquarto (v0.5.0). https://anaconda.org/conda-forge/lintquarto.
Heather, A. (2025). lintquarto (v0.5.0). https://doi.org/10.5281/zenodo.15731161.
Citation instructions are also provided in CITATION.cff.
Acknowledgements
This project was written and maintained by hand, with occasional use of Perplexity during development. AI assistance was used for small, targeted tasks (e.g. help when troubleshooting, identifying issues, refining docstrings, improving code structure), rather than to generate complete functions or substantial content. All code and design decisions were reviewed and finalised by a human. For transparency, the use of AI is acknowledged, but the project should not be considered AI‑generated.
Owner
- Name: lintquarto
- Login: lintquarto
- Kind: organization
- Repositories: 1
- Profile: https://github.com/lintquarto
GitHub Events
Total
- Create event: 16
- Release event: 3
- Issues event: 33
- Delete event: 11
- Issue comment event: 12
- Push event: 80
- Pull request event: 23
Last Year
- Create event: 16
- Release event: 3
- Issues event: 33
- Delete event: 11
- Issue comment event: 12
- Push event: 80
- Pull request event: 23
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 39
- Total pull requests: 38
- Average time to close issues: 9 days
- Average time to close pull requests: less than a minute
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.69
- Average comments per pull request: 0.0
- Merged pull requests: 31
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 39
- Pull requests: 38
- Average time to close issues: 9 days
- Average time to close pull requests: less than a minute
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.69
- Average comments per pull request: 0.0
- Merged pull requests: 31
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- amyheather (39)
Pull Request Authors
- amyheather (38)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 259 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 1
pypi.org: lintquarto
Package for running linters, static type checkers and code analysis tools on python code in quarto (.qmd) files.
- Homepage: https://github.com/lintquarto/lintquarto
- Documentation: https://lintquarto.readthedocs.io/
- License: MIT License
-
Latest release: 0.5.0
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- pylint *
- flit *
- pylint *
- pytest *
- twine *