https://github.com/stelewis/tq
A Python test quality toolkit written in Rust
https://github.com/stelewis/tq
linter python testing
Last synced: 3 months ago
JSON representation
A Python test quality toolkit written in Rust
- Host: GitHub
- URL: https://github.com/stelewis/tq
- Owner: stelewis
- License: mit
- Created: 2026-03-02T00:07:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-06T00:57:08.000Z (3 months ago)
- Last Synced: 2026-04-06T02:25:26.560Z (3 months ago)
- Topics: linter, python, testing
- Language: Rust
- Homepage: https://stelewis.github.io/tq/
- Size: 979 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# `tq` - Test Quality Toolkit
[](https://stelewis.github.io/tq/)
`tq` inspects a codebase's tests and enforces quality rules so tests remain discoverable, focused, actionable, and maintainable.
## Installation
PyPI distribution name: `tqlint`
Add to a project:
```sh
uv add --dev tqlint
uv run tq check
```
Run without installing (ephemeral):
```sh
uvx --from tqlint tq check
```
Install as a persistent global tool:
```sh
uv tool install tqlint
tq check
```
Install with `pip`:
```sh
python -m pip install tqlint
tq check
```
Note: `uvx tq check` is not currently available because the `tq` package name on PyPI is owned by another project. Use `uvx --from tqlint tq ...` for ephemeral runs.
## Usage
Run checks:
```sh
uv run tq check
```
## Configuration
[Configure](https://stelewis.github.io/tq/reference/configuration.html) `tq` in `pyproject.toml` under `[tool.tq]`:
```toml
[tool.tq]
init_modules = "ignore"
max_test_file_non_blank_lines = 600
qualifier_strategy = "allowlist"
allowed_qualifiers = ["regression"]
[[tool.tq.targets]]
name = "tq"
package = "tq"
source_root = "src"
test_root = "tests"
```
## Documentation
[`tq` documentation](https://stelewis.github.io/tq/)
## Language support
`tq` currently only analyzes Python source and Python tests (`.py`).
## Development
Contributions are welcomed!
Contribution guidelines and development setup steps are documented in [CONTRIBUTING.md](CONTRIBUTING.md).