artifact-lint-py

A python framework for developing artifact linters

Docs: https://whatsacomputertho.github.io/artifact-lint-py/

Contributing: CONTRIBUTING.md

Quick Example

from lint.rule import LintRule
from lint.result import LintResult
from lint.status import LintStatus

class IntegerIsEven(LintRule[int]):
    def lint(self, artifact: int) -> LintResult:
        if artifact % 2 == 0:
            return LintResult(
                status=LintStatus.INFO,
                message=f"({self.name()}) Integer was even: {artifact}"
            )
        return LintResult(
            status=LintStatus.ERROR,
            message=f"({self.name()}) Integer was odd: {artifact}"
        )
integer_is_even = IntegerIsEven()

# Lint an even integer
even_result = integer_is_even.lint(2)
print(even_result)

# Lint an odd integer
odd_result = integer_is_even.lint(337)
print(odd_result)

To run this example, simply execute the following from the root of this repository

python3 examples/quick-example.py

Installation

Using Pip

Run the following command to install the latest version of this package

pip install artifact-lint-py

Local Install

1. Clone this repository
2. Build the project from source
3. Locate the .whl (wheel) file in the dist folder
   • It should be named something like so: artifact_lint_py-1.0.1-py3-none-any.whl
4. Run the following command from the root of the repository, replacing the name of the .whl file if necessary

   pip install dist/artifact_lint_py-1.0.1-py3-none-any.whl
   

Build

From the root of this repository, execute

make build

Under the hood, this will execute python3 -m build and produce a .whl (wheel) and .tgz (TAR-GZip archive) file in the dist subdirectory. For more on this project's make recipes, see CONTRIBUTING.md.