Skip to main content

tq inspects a codebase's tests and enforces quality rules so tests remain discoverable, focused, actionable, and maintainable

Project description

tq - Test Quality Toolkit

Documentation

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:

uv add --dev tqlint
uv run tq check

Run without installing (ephemeral):

uvx tqlint check

Install as a persistent global tool:

uv tool install tqlint
tq check

Install with pip:

python -m pip install tqlint
tq check

Note: uvx tq check is not available because the tq package name on PyPI is owned by another project.

Usage

Run checks:

uv run tq check

Configuration

Configure tq in pyproject.toml under [tool.tq]:

[tool.tq]
ignore_init_modules = true
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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tqlint-0.6.2.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tqlint-0.6.2-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file tqlint-0.6.2.tar.gz.

File metadata

  • Download URL: tqlint-0.6.2.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tqlint-0.6.2.tar.gz
Algorithm Hash digest
SHA256 b14f1f6098c7101b89cde1349df1fc8cfa2d716b4315d476ddb5e073f847ba87
MD5 8e11d270c1ac906c669658b5a48922b5
BLAKE2b-256 c753d22cc2bf6ebcff97e19ffac8d61eef0d2ad8a53ca20135661d4118ddd271

See more details on using hashes here.

File details

Details for the file tqlint-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: tqlint-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tqlint-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5465a4245388e66740bded1020d3ad3c50557ab753bb9ebac3f21e0bc9e54386
MD5 3d04bcbb3a520486410cc256889bddaa
BLAKE2b-256 7885b2ac975662007ed99ea4861ef192db60b826873470bf758e27ae39d8741f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page