cfn-check 0.1.1__tar.gz → 0.2.0__tar.gz

{cfn_check-0.1.1 → cfn_check-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfn-check
-Version: 0.1.1
+Version: 0.2.0
 Summary: Validate Cloud Formation
 Author-email: Ada Lundhe <adalundhe@lundhe.audio>
 License: MIT License
@@ -39,7 +39,7 @@ Requires-Dist: hyperlight-cocoa
 Requires-Dist: async-logging
 Dynamic: license-file
 
-# <b>CFN Check</b>
+# <b>CFN-Check</b>
 <b>A tool for checking CloudFormation</b>
 
 [![PyPI version](https://img.shields.io/pypi/v/cfn-check?color=blue)](https://pypi.org/project/cfn-check/)
@@ -48,16 +48,16 @@ Dynamic: license-file
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cfn-check?color=red)](https://pypi.org/project/cfn-check/)
 
 
-| Package     | Cocoa                                                           |
+| Package     | cfn-check                                                           |
 | ----------- | -----------                                                     |
-| Version     | 0.1.0                                                           |
+| Version     | 0.2.0                                                           |
 | Download    | https://pypi.org/project/cfn-check/                             | 
 | Source      | https://github.com/adalundhe/cfn-check                          |
 | Keywords    | cloud-formation, testing, aws, cli                              |
 
 
 CFN-Check is a small, fast, friendly tool for validating AWS CloudFormation YAML templates. It is code-driven, with 
-rules written as simple, `Rule` decorator wrapped python class methods for `Rules`-inheriting classes.
+rules written as simple, `Rule` decorator wrapped python class methods for `Collection`-inheriting classes.
 
 <br/>
 
@@ -88,7 +88,7 @@ Cloud Formation easy while offering both CLI and Python API interfaces.
 
 - `Python 3.12`
 - Any number of valid CloudFormation templates or a path to said templates.
-- A `.py` file containing at least one `Rules` class with at least one valid `@Rule()` decorated method
+- A `.py` file containing at least one `Collection` class with at least one valid `@Rule()` decorated method
 
 To get started (we recommend using `uv`), run:
 
@@ -106,10 +106,10 @@ Next open the `rules.py` file and create a basic Python class
 as below.
 
 ```python
-from cfn_check import Rules, Rule
+from cfn_check import Collection, Rule
 
 
-class ValidateResourceType(Rules):
+class ValidateResourceType(Collection):
 
     @Rule(
         "Resources::*::Type",

{cfn_check-0.1.1 → cfn_check-0.2.0}/README.md

@@ -1,4 +1,4 @@
-# <b>CFN Check</b>
+# <b>CFN-Check</b>
 <b>A tool for checking CloudFormation</b>
 
 [![PyPI version](https://img.shields.io/pypi/v/cfn-check?color=blue)](https://pypi.org/project/cfn-check/)
@@ -7,16 +7,16 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cfn-check?color=red)](https://pypi.org/project/cfn-check/)
 
 
-| Package     | Cocoa                                                           |
+| Package     | cfn-check                                                           |
 | ----------- | -----------                                                     |
-| Version     | 0.1.0                                                           |
+| Version     | 0.2.0                                                           |
 | Download    | https://pypi.org/project/cfn-check/                             | 
 | Source      | https://github.com/adalundhe/cfn-check                          |
 | Keywords    | cloud-formation, testing, aws, cli                              |
 
 
 CFN-Check is a small, fast, friendly tool for validating AWS CloudFormation YAML templates. It is code-driven, with 
-rules written as simple, `Rule` decorator wrapped python class methods for `Rules`-inheriting classes.
+rules written as simple, `Rule` decorator wrapped python class methods for `Collection`-inheriting classes.
 
 <br/>
 
@@ -47,7 +47,7 @@ Cloud Formation easy while offering both CLI and Python API interfaces.
 
 - `Python 3.12`
 - Any number of valid CloudFormation templates or a path to said templates.
-- A `.py` file containing at least one `Rules` class with at least one valid `@Rule()` decorated method
+- A `.py` file containing at least one `Collection` class with at least one valid `@Rule()` decorated method
 
 To get started (we recommend using `uv`), run:
 
@@ -65,10 +65,10 @@ Next open the `rules.py` file and create a basic Python class
 as below.
 
 ```python
-from cfn_check import Rules, Rule
+from cfn_check import Collection, Rule
 
 
-class ValidateResourceType(Rules):
+class ValidateResourceType(Collection):
 
     @Rule(
         "Resources::*::Type",
@@ -203,4 +203,4 @@ which outputs:
 2025-09-17T01:46:41.542078+00:00 - INFO - 19783474 - /Users/adalundhe/Documents/Duckbill/cfn-check/cfn_check/cli/validate.py:validate.80 - ✅ 1 validations met for 1 templates
 ```
 
-Congrats! You've just made the cloud a bit better place!
+Congrats! You've just made the cloud a bit better place!

cfn_check-0.2.0/cfn_check/__init__.py

@@ -0,0 +1,2 @@
+from .collection.collection import Collection as Collection
+from .rules.rule import Rule as Rule

{cfn_check-0.1.1 → cfn_check-0.2.0}/cfn_check/cli/utils/attributes.py

@@ -1,9 +1,9 @@
-from cfn_check.rules.rules import Rules
+from cfn_check.collection.collection import Collection
 from cfn_check.validation.validator import Validator
 
 
 def bind(
-    rule_set: Rules,
+    rule_set: Collection,
     validation: Validator
 ):
     validation.func = validation.func.__get__(rule_set, rule_set.__class__)

{cfn_check-0.1.1 → cfn_check-0.2.0}/cfn_check/cli/validate.py

@@ -7,7 +7,7 @@ from cfn_check.cli.utils.attributes import bind
 from cfn_check.cli.utils.files import load_templates
 from cfn_check.evaluation.validate import run_validations
 from cfn_check.logging.models import InfoLog
-from cfn_check.rules.rules import Rules
+from cfn_check.collection.collection import Collection
 from cfn_check.validation.validator import Validator
 
 
@@ -15,7 +15,7 @@ from cfn_check.validation.validator import Validator
 async def validate(
     path: str,
     file_pattern: str | None = None,
-    rules: ImportType[Rules] = None,
+    rules: ImportType[Collection] = None,
     tags: list[str] = [
         'Ref',
         'Sub',
@@ -38,7 +38,7 @@ async def validate(
     '''
     Validate Cloud Foundation
     
-    @param rules Path to a file containing Rules
+    @param rules Path to a file containing Collections
     @param file_pattern A string pattern used to find template files
     @param tags List of CloudFormation intrinsic function tags
     @param log_level The log level to use

cfn_check-0.2.0/cfn_check/collection/collection.py

@@ -0,0 +1,2 @@
+class Collection:
+    pass

{cfn_check-0.1.1 → cfn_check-0.2.0}/cfn_check.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfn-check
-Version: 0.1.1
+Version: 0.2.0
 Summary: Validate Cloud Formation
 Author-email: Ada Lundhe <adalundhe@lundhe.audio>
 License: MIT License
@@ -39,7 +39,7 @@ Requires-Dist: hyperlight-cocoa
 Requires-Dist: async-logging
 Dynamic: license-file
 
-# <b>CFN Check</b>
+# <b>CFN-Check</b>
 <b>A tool for checking CloudFormation</b>
 
 [![PyPI version](https://img.shields.io/pypi/v/cfn-check?color=blue)](https://pypi.org/project/cfn-check/)
@@ -48,16 +48,16 @@ Dynamic: license-file
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cfn-check?color=red)](https://pypi.org/project/cfn-check/)
 
 
-| Package     | Cocoa                                                           |
+| Package     | cfn-check                                                           |
 | ----------- | -----------                                                     |
-| Version     | 0.1.0                                                           |
+| Version     | 0.2.0                                                           |
 | Download    | https://pypi.org/project/cfn-check/                             | 
 | Source      | https://github.com/adalundhe/cfn-check                          |
 | Keywords    | cloud-formation, testing, aws, cli                              |
 
 
 CFN-Check is a small, fast, friendly tool for validating AWS CloudFormation YAML templates. It is code-driven, with 
-rules written as simple, `Rule` decorator wrapped python class methods for `Rules`-inheriting classes.
+rules written as simple, `Rule` decorator wrapped python class methods for `Collection`-inheriting classes.
 
 <br/>
 
@@ -88,7 +88,7 @@ Cloud Formation easy while offering both CLI and Python API interfaces.
 
 - `Python 3.12`
 - Any number of valid CloudFormation templates or a path to said templates.
-- A `.py` file containing at least one `Rules` class with at least one valid `@Rule()` decorated method
+- A `.py` file containing at least one `Collection` class with at least one valid `@Rule()` decorated method
 
 To get started (we recommend using `uv`), run:
 
@@ -106,10 +106,10 @@ Next open the `rules.py` file and create a basic Python class
 as below.
 
 ```python
-from cfn_check import Rules, Rule
+from cfn_check import Collection, Rule
 
 
-class ValidateResourceType(Rules):
+class ValidateResourceType(Collection):
 
     @Rule(
         "Resources::*::Type",

{cfn_check-0.1.1 → cfn_check-0.2.0}/cfn_check.egg-info/SOURCES.txt

@@ -14,6 +14,8 @@ cfn_check/cli/validate.py
 cfn_check/cli/utils/__init__.py
 cfn_check/cli/utils/attributes.py
 cfn_check/cli/utils/files.py
+cfn_check/collection/__init__.py
+cfn_check/collection/collection.py
 cfn_check/evaluation/__init__.py
 cfn_check/evaluation/check.py
 cfn_check/evaluation/errors.py
@@ -25,7 +27,6 @@ cfn_check/logging/__init__.py
 cfn_check/logging/models.py
 cfn_check/rules/__init__.py
 cfn_check/rules/rule.py
-cfn_check/rules/rules.py
 cfn_check/shared/__init__.py
 cfn_check/shared/types.py
 cfn_check/validation/__init__.py

{cfn_check-0.1.1 → cfn_check-0.2.0}/example/rules.py

@@ -1,7 +1,7 @@
-from cfn_check import Rules, Rule
+from cfn_check import Collection, Rule
 
 
-class ValidateResourceTypes(Rules):
+class ValidateResourceTypes(Collection):
 
     @Rule(
         "Resources::*::Type",

{cfn_check-0.1.1 → cfn_check-0.2.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cfn-check"
-version = "0.1.1"
+version = "0.2.0"
 requires-python = ">=3.12"
 description = "Validate Cloud Formation"
 readme = "README.md"

cfn_check-0.1.1/cfn_check/__init__.py

@@ -1,2 +0,0 @@
-from .rules.rules import Rules as Rules
-from .rules.rule import Rule as Rule

cfn_check-0.1.1/cfn_check/rules/rules.py

@@ -1,2 +0,0 @@
-class Rules:
-    pass