artifact-lint-py 1.0.0__py3-none-any.whl

artifact_lint_py-1.0.0.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: artifact-lint-py
+Version: 1.0.0
+Summary: A python framework for developing artifact linters
+Author-email: Ethan Balcik <ethanbalcik@ibm.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/whatsacomputertho/artifact-lint-py
+Project-URL: Issues, https://github.com/whatsacomputertho/artifact-lint-py/issues
+Keywords: artifact,lint,py,linter
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema
+Provides-Extra: test
+Requires-Dist: tox; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Dynamic: license-file
+
+![artifact-lint-py](https://raw.githubusercontent.com/whatsacomputertho/artifact-lint-py/main/doc/source/_static/artifact-lint-py.png)
+
+# artifact-lint-py
+
+[![Test](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/test.yaml/badge.svg)](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/test.yaml) [![Sec](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/sec.yaml/badge.svg)](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/sec.yaml) [![Doc](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/doc.yaml/badge.svg)](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/doc.yaml) [![Build](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/build.yaml/badge.svg)](https://github.com/whatsacomputertho/artifact-lint-py/actions/workflows/build.yaml)
+
+A python framework for developing artifact linters
+
+**Docs**: https://whatsacomputertho.github.io/artifact-lint-py/
+
+**Contributing**: [CONTRIBUTING.md](https://github.com/whatsacomputertho/artifact-lint-py/blob/main/CONTRIBUTING.md)
+
+## Quick Example
+
+```python
+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
+```bash
+python3 examples/quick-example.py
+```
+
+## Installation
+
+### Using Pip
+
+Run the following command to install the latest version of this package
+```bash
+pip install artifact-lint-py
+```
+
+### Local Install
+
+1. Clone this repository
+2. [Build the project from source](#build)
+3. Locate the `.whl` (wheel) file in the `dist` folder
+    - It should be named something like so: artifact_lint_py-1.0.0-py3-none-any.whl
+4. Run the following command from the root of the repository, replacing the name of the `.whl` file if necessary
+    ```bash
+    pip install dist/artifact_lint_py-1.0.0-py3-none-any.whl
+    ```
+
+## Build
+
+From the root of this repository, execute
+```bash
+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](CONTRIBUTING.md).

artifact_lint_py-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+artifact_lint_py-1.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lint/__init__.py,sha256=MWztYPbvFVccqjt0PfA2sBAHH-BRv6XfJKK9-zudhfE,111
+lint/config.py,sha256=-7izOiZv8vsg1ZSkDSPcmJZvKhKbR7SFP5oupZ5134U,5789
+lint/linter.py,sha256=W2b79AuvJFy2rw1clhI0ACYQdRvmrMKQqYxyYvMh6Bc,1762
+lint/result.py,sha256=4IaYgwqz8P4FcEAUrEzY7ytsK4yxklL0nPl3znYjRyg,917
+lint/rule.py,sha256=27sR-1UIxauUdc-Z8x-A_8tCQX838angJtLClYkHQMo,1106
+lint/status.py,sha256=jPQmiJOjhjNmJiP9WRmk0pmqtW5TvzD7MdtqhwBlUo0,1467
+lint/typing.py,sha256=331Cf1MVV3kEnoSASCNXsrZSfXWdQ4bGFoKNUzdEZEk,45
+artifact_lint_py-1.0.0.dist-info/METADATA,sha256=GiYziTNiR5ueVfWAs-9MVO5FlX0RVVwAVE3ezNZ8snM,3839
+artifact_lint_py-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+artifact_lint_py-1.0.0.dist-info/top_level.txt,sha256=2VAJcqXDWPMMW7Me8zy4h_0plLbzH2QwOOrYYD8bBZU,5
+artifact_lint_py-1.0.0.dist-info/RECORD,,

artifact_lint_py-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

artifact_lint_py-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

artifact_lint_py-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+lint

lint/__init__.py

@@ -0,0 +1,6 @@
+import lint.config
+import lint.linter
+import lint.result
+import lint.rule
+import lint.status
+import lint.typing

lint/config.py

@@ -0,0 +1,193 @@
+from jsonschema import validate, ValidationError
+from lint.typing import T
+from typing import Generic, Any
+
+DEFAULT_LINT_RULE_CONFIG_SCHEMA = {
+    "type": "object",
+    "required": [ "enabled" ],
+    "properties": {
+        "enabled": {
+            "type": "boolean"
+        }
+    }
+}
+"""
+The default lint rule config schema, which enforces that lint rule config
+dicts have a boolean property named enabled
+"""
+
+DEFAULT_LINTER_CONFIG_SCHEMA = {
+    "type": "object",
+    "additionalProperties": False,
+    "patternProperties": {
+        "^[A-Z][a-zA-Z0-9]*$": DEFAULT_LINT_RULE_CONFIG_SCHEMA
+    }
+}
+"""
+The default schema for a linter config, which enforces that lint rule names
+are PascalCase and that each lint rule config satisfies its default schema
+"""
+
+class LintRuleConfig(Generic[T]):
+    """
+    The LintRuleConfig class represents the configuration for a lint rule
+    """
+    @staticmethod
+    def validate_static(
+            config: dict[str, Any],
+            schema: dict[str, Any]=DEFAULT_LINT_RULE_CONFIG_SCHEMA
+        ) -> tuple[bool, str]:
+        """
+        Validates a LintRuleConfig dictionary
+
+        Args:
+            config (dict): The lint rule config dictionary
+            schema (dict): The lint rule config dictionary
+        
+        Returns:
+            bool: Whether the lint rule config dict was valid
+            str: Error message if the config dict was invalid
+        """
+        try:
+            validate(schema=schema, instance=config)
+        except ValidationError as ve:
+            return False, str(ve)
+        return True, ""
+
+    def __init__(
+            self,
+            config: dict[str, Any],
+            schema: dict[str, Any]=DEFAULT_LINT_RULE_CONFIG_SCHEMA
+        ):
+        """
+        Constructor for the LintRuleConfig class
+
+        Args:
+            config (dict): The lint rule config dictionary
+            schema (dict): The lint rule config JSON schema dictionary
+        
+        Returns:
+            LintRuleConfig: The initialized lint rule config object
+        """
+        # Validate the lint rule config
+        valid, err = LintRuleConfig.validate_static(config, schema)
+        if not valid:
+            raise ValidationError(err)
+        
+        # If valid, save the config & schema as object properties
+        self.config = config
+        self.schema = schema
+
+    def validate(self) -> tuple[bool, str]:
+        """
+        Validates a LintRuleConfig instance
+        
+        Returns:
+            bool: Whether the config dict was valid
+            str: Error message if the config dict was invalid
+        """
+        return LintRuleConfig.validate_static(self.config, self.schema)
+
+    def enabled(self) -> bool:
+        """
+        Determines whether the lint rule is enabled
+        
+        Returns:
+            bool: Whether the lint rule is enabled
+        """
+        return self.config.get("enabled", False)
+    
+    def __dict__(self) -> dict[str, Any]:
+        """
+        Serialize the LintRuleConfig as a python dictionary
+
+        Returns:
+            dict: The lint rule config as a dict
+        """
+        return self.config
+
+class LinterConfig(Generic[T]):
+    """
+    The LinterConfig class represents the configuration for a linter
+    """
+    @staticmethod
+    def validate_static(
+            config: dict[str, Any],
+            schema: dict[str, Any]=DEFAULT_LINTER_CONFIG_SCHEMA
+        ) -> tuple[bool, str]:
+        """
+        Validates a LinterConfig dictionary
+
+        Args:
+            config (dict): The linter config dictionary
+            schema (dict): The linter config JSON schema dictionary
+        
+        Returns:
+            bool: Whether the config dict was valid
+            str: Error message if the config dict was invalid
+        """
+        try:
+            validate(schema=schema, instance=config)
+        except ValidationError as ve:
+            return False, str(ve)
+        return True, ""
+
+    def __init__(
+            self,
+            config: dict[str, Any],
+            schema: dict[str, Any]=DEFAULT_LINTER_CONFIG_SCHEMA
+        ):
+        """
+        Constructor for the LinterConfig class
+
+        Args:
+            config (dict): The linter config dictionary
+            schema (dict): The linter config JSON schema dictionary
+        """
+        # Validate the linter config
+        valid, err = LinterConfig.validate_static(config, schema)
+        if not valid:
+            raise ValidationError(err)
+        
+        # If valid, save the config & schema as object properties
+        # Convert each lint rule config to a LintRuleConfig before saving
+        self.config = { 
+            key: LintRuleConfig(value) for key, value in config.items()
+        }
+        self.schema = schema
+
+    def validate(self) -> tuple[bool, str]:
+        """
+        Validates a LinterConfig instance
+        
+        Returns:
+            bool: Whether the config dict was valid
+            str: Error message if the config dict was invalid
+        """
+        return LinterConfig.validate_static(self.__dict__(), self.schema)
+
+    def enabled(self, rule: str) -> bool:
+        """
+        Determines whether a given lint rule is enabled in the lint config
+
+        Args:
+            rule (str): The name of the lint rule
+        
+        Returns:
+            bool: Whether the lint rule is enabled
+        """
+        for key in self.config.keys():
+            if rule == str(key):
+                return self.config.get(key).enabled()
+        return False
+
+    def __dict__(self) -> dict[str, Any]:
+        """
+        Serialize the LinterConfig as a python dictionary
+
+        Returns:
+            dict: The linter config serialized as a dict
+        """
+        return {
+            key: value.__dict__() for key, value in self.config.items()
+        }

lint/linter.py

@@ -0,0 +1,58 @@
+from lint.config import LinterConfig
+from lint.result import LintResult
+from lint.rule import LintRule, DEFAULT_LINT_RULE_CONFIG
+from lint.typing import T
+from typing import Generic
+
+DEFAULT_LINTER_CONFIG = LinterConfig({})
+
+class Linter(Generic[T]):
+    """
+    The Linter class applies potentially multiple lint rules against an
+    artifact, returning the list of lint results for each enforced rule
+    """
+    def __init__(
+            self,
+            rules: list[LintRule[T]]
+        ):
+        """
+        Constructor for the Linter class
+
+        Args:
+            rules (list): The lint rules enforced by the linter
+        """
+        self.rules = rules
+
+    def lint(
+            self,
+            artifact: T,
+            config: LinterConfig[T]=DEFAULT_LINTER_CONFIG,
+            **kwargs
+        ) -> list[LintResult]:
+        """
+        Applies the linter's lint rules against an artifact, returning the list
+        of lint results for each enforced rule
+
+        Args:
+            artifact (T): The artifact to lint
+            config (LinterConfig): The configuration for the linter
+        
+        Returns:
+            list: The list of LintResults corresponding to each lint rule
+        """
+        results = []
+        for rule in self.rules:
+            rule_name = rule.name()
+            if config.enabled(rule_name):
+                results.append(
+                    rule.lint(
+                        artifact,
+                        config.config.get(
+                            rule_name,
+                            DEFAULT_LINT_RULE_CONFIG
+                        )
+                    )
+                )
+            else:
+                results.append(LintResult(message=f"{rule_name} disabled"))
+        return results

lint/result.py

@@ -0,0 +1,31 @@
+from lint.status import LintStatus
+
+class LintResult:
+    """
+    The LintResult class represents the result of a lint rule after the rule
+    has been enforced against an artifact. It includes a LintStatus indicating
+    the severity of the result, and a message represented as a string.
+    """
+    def __init__(
+            self,
+            status: LintStatus=LintStatus.INFO,
+            message: str=""
+        ):
+        """
+        Constructor for the LintResult class
+
+        Args:
+            status (LintStatus): The status / severity of the lint result
+            message (str): A message describing the lint result
+        """
+        self.status = status
+        self.message = message
+
+    def __str__(self) -> str:
+        """
+        Formats the lint result as a string
+
+        Returns:
+            str: The lint result as a string
+        """
+        return f"{str(self.status)}: {self.message}"

lint/rule.py

@@ -0,0 +1,39 @@
+from lint.config import LintRuleConfig
+from lint.result import LintResult
+from lint.typing import T
+from typing import Generic
+
+DEFAULT_LINT_RULE_CONFIG = LintRuleConfig({"enabled": True})
+
+class LintRule(Generic[T]):
+    """
+    The LintRule class represents a rule that can be enforced against an
+    artifact. When enforced, it produces a LintResult which describes the
+    outcome of enforcing the rule.
+    """
+    def name(self) -> str:
+        """
+        Returns the name of the lint rule
+
+        Returns:
+            str: The name of the lint rule
+        """
+        return type(self).__name__
+
+    def lint(
+            self,
+            artifact: T,
+            config: LintRuleConfig[T]=DEFAULT_LINT_RULE_CONFIG,
+            **kwargs
+        ) -> LintResult:
+        """
+        Enforces the lint rule against an artifact
+
+        Args:
+            artifact (T): An artifact to lint
+            config (LintRuleConfig): The configuration for this lint rule
+        
+        Returns:
+            LintResult: The lint result
+        """
+        return LintResult(message="Not yet implemented")

lint/status.py

@@ -0,0 +1,49 @@
+from enum import Enum
+from typing import Union
+
+class LintStatus(Enum):
+    """
+    The LintStatus enum represents the status or severity of a lint rule's
+    result after the rule is enforced against an artifact.
+    """
+    INFO = 0
+    WARNING = 1
+    ERROR = 2
+
+    @staticmethod
+    def try_from_name(
+            name: str
+        ) -> tuple[Union["LintStatus", None], str]:
+        """
+        Try to load a LintStatus from its name property serialized as a string
+
+        Args:
+            name (str): The name of the LintStatus enum
+
+        Returns:
+            LintStatus: The loaded LintStatus, or None if not loaded
+            str: Error message if the LintStatus was not loaded successfully
+        """
+        try:
+            return LintStatus[name], ""
+        except KeyError:
+            return None, f"Task status name does not exist: {name}"
+
+    @staticmethod
+    def try_from_value(
+            value: int
+        ) -> tuple[Union["LintStatus", None], str]:
+        """
+        Try to load a LintStatus from its value property serialized as an int
+
+        Args:
+        value (int): The value of the LintStatus enum
+
+        Returns:
+            LintStatus: The loaded LintStatus, or None if not loaded
+            str: Error message if the LintStatus was not loaded successfully
+        """
+        try:
+            return LintStatus(value), ""
+        except ValueError:
+            return None, f"Task status value out of range: {value}"

lint/typing.py

@@ -0,0 +1,3 @@
+from typing import TypeVar
+
+T = TypeVar('T')