lintkit

lintkit is a framework for building linters/code checking rules

Multiple formats: Python-first, but supports YAML, JSON and TOML
Comprehensive: noqa comments, file skips and standardized pretty output
Quick: Create and run custom rules in a few lines of code
Flexible: Rules over file(s), their subelements and more (see Files tutorial)
Minimal: Gentle learning curve - <1000 lines of code, tutorials, API reference

🚀 Quick start 📚 Documentation 🤝 Contribute 👍 Adopters 📜 Legal

Quick start

[!TIP] Check out more examples (here) to get a better feel of lintkit.

Below are ~20 lines of code implementing custom linter with two rules and running it on three files:

import lintkit

# Set the name of the linter
lintkit.settings.name = "NOUTILS"


class _NoUtils(lintkit.check.Regex, lintkit.loader.Python, lintkit.rule.Node):
    def regex(self):
        # Regex to match util(s) variations in function/class name
        return r"_?[Uu]til(s|ities)?"

    def values(self):
        # Yield class or function names from a Python file
        data = self.getitem("nodes_map")
        for node in data[self.ast_class()]:
            yield lintkit.Value.from_python(node.name, node)

    def message(self, _):
        return f"{self.ast_class()} name contains util(s) word"


# Concrete rules and their codes
# Disabling linter using noqas supported out of the box!
class ClassNoUtils(_NoUtils, code=0):  # noqa: NOUTILS0
    # ast type we want to focus on in this rule
    def ast_class(self):
        return ast.ClassDef


class FunctionNoUtils(_NoUtils, code=1):  # noqa: NOUTILS0
    def ast_class(self):
        return ast.FunctionDef


lintkit.run(["linter.py", "file1.py", "file2.py"])

# Example output
# /path/file1.py:23:17 NOUTILS0: ClassDef name contains util(s) word
# /path/file2.py:73:21 NOUTILS1: FunctionDef name contains util(s) word

Installation

[!TIP] You can use your favorite package manager like uv, hatch or pdm instead of pip.

> pip install lintkit

[!NOTE] lintkit provides extras (rich, toml, yaml and all containing everything) to provide additional functionality.

# To create rules utilizing YAML
> pip install lintkit[rich, yaml]

Learn

Check out the following links to learn more about lintkit:

Contribute

We welcome your contributions! Start here:

Legal

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
This project is copyrighted by open-nudge - the appropriate copyright notice is included in each file.

Download files

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

Source Distribution

lintkit-3.0.0.tar.gz (44.2 kB view details)

Uploaded Aug 24, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

lintkit-3.0.0-py3-none-any.whl (47.6 kB view details)

Uploaded Aug 24, 2026 Python 3

File details

Details for the file lintkit-3.0.0.tar.gz.

File metadata

Download URL: lintkit-3.0.0.tar.gz
Upload date: Aug 24, 2026
Size: 44.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lintkit-3.0.0.tar.gz
Algorithm	Hash digest
SHA256	`2cc85d56788ac372cc461a734962d9a54c6b98a31f45afd6ade37880e5c34c3f`
MD5	`51d4bb19a906e0c2f9d91459e8df31f7`
BLAKE2b-256	`f75afa51a6046cb03db4f2ef754f85fc225555675f634bde6ee6a93c26c5bbd9`

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintkit-3.0.0.tar.gz:

Publisher: release.yml on open-nudge/lintkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: lintkit-3.0.0.tar.gz
- Subject digest: 2cc85d56788ac372cc461a734962d9a54c6b98a31f45afd6ade37880e5c34c3f
- Sigstore transparency entry: 2582024519
- Sigstore integration time: Aug 24, 2026
Source repository:
- Permalink: open-nudge/lintkit@2e4d4a477c9729a9578ac196a2651c12d6e2172b
- Branch / Tag: refs/tags/v0.7.0
- Owner: https://github.com/open-nudge
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2e4d4a477c9729a9578ac196a2651c12d6e2172b
- Trigger Event: release