cfn-check 0.1.1__py3-none-any.whl → 0.2.1__py3-none-any.whl

cfn_check/__init__.py

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

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/cli/utils/files.py

@@ -1,6 +1,7 @@
 
 import asyncio
 import os
+import pathlib
 import yaml
 from cfn_check.loader.loader import (
     Loader,
@@ -9,23 +10,62 @@ from cfn_check.loader.loader import (
 )
 from cfn_check.shared.types import YamlObject, Data
 
-def open_template(path: str) -> YamlObject | Exception:
+def open_template(path: str) -> YamlObject | None:
+
+    if os.path.exists(path) is False:
+        return None
+
     try:
         with open(path, 'r') as f:
             return yaml.load(f, Loader=Loader)
-    except (Exception, ) as e:
+    except Exception as e:
         raise e
     
 def is_file(path: str) -> bool:
     return os.path.isdir(path) is False
 
 
+async def path_exists(path: str, loop: asyncio.AbstractEventLoop):
+    return await loop.run_in_executor(
+        None,
+        os.path.exists,
+        path,
+    )
+
+async def convert_to_cwd(loop: asyncio.AbstractEventLoop):
+    return await loop.run_in_executor(
+        None,
+        os.getcwd,
+    )
+
+async def localize_path(path: str, loop: asyncio.AbstractEventLoop):
+    localized = path.replace('~/', '')
+
+    home_directory = await loop.run_in_executor(
+        None,
+        pathlib.Path.home,
+    )
+
+    return await loop.run_in_executor(
+        None,
+        os.path.join,
+        home_directory,
+        localized,
+    )
+
 async def load_templates(
     path: str,
     tags: list[str],
     file_pattern: str | None = None,
 ):
+
     loop = asyncio.get_event_loop()
+    
+    if path == '.':
+        path = await convert_to_cwd(loop)
+
+    elif path.startswith('~/'):
+        path = await localize_path(path, loop)
 
     if await loop.run_in_executor(
         None,
@@ -36,6 +76,8 @@ async def load_templates(
             path,
         ]
 
+        assert await path_exists(path) is True, f'❌ Template at {path} does not exist'
+
     elif file_pattern:
 
         template_filepaths = await loop.run_in_executor(
@@ -65,4 +107,10 @@ async def load_templates(
         ) for template_path in template_filepaths
     ])
 
+    found_templates = [
+        template for template in templates if template is not None
+    ]
+
+    assert len(found_templates) > 0, "❌ Could not open any templates"
+
     return templates

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/collection/collection.py

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

{cfn_check-0.1.1.dist-info → cfn_check-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfn-check
-Version: 0.1.1
+Version: 0.2.1
 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",
@@ -241,7 +241,7 @@ cfn-lint validate -r rules.py template.yaml
 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
+2025-09-17T01:46:41.542078+00:00 - INFO - 19783474 - /Users/adalundhe/Documents/adalundhe/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!

{cfn_check-0.1.1.dist-info → cfn_check-0.2.1.dist-info}/RECORD

@@ -1,10 +1,12 @@
-cfn_check/__init__.py,sha256=k1-xUfaN07znTID-I4uJcP3l1cWG3Fr-hPFoB5NVKHk,76
+cfn_check/__init__.py,sha256=ccUo2YxBmuEmak1M5o-8J0ECLXNkDDUsLJ4mkm31GvU,96
 cfn_check/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfn_check/cli/root.py,sha256=dHq9zzXyj-Wrj-fzirtFjptShzWbBGsO3n9tspm-pec,1688
-cfn_check/cli/validate.py,sha256=qUQ-4BFZAfqCh2lc12dkR6EwimXmRJCfw_0cLvOzkK8,1987
+cfn_check/cli/validate.py,sha256=e20Hyfs3GJSrBbMRPt8dy3L0yjVnYo36ol_zOVhZco8,2013
 cfn_check/cli/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cfn_check/cli/utils/attributes.py,sha256=zKOZhyWYsU1qcBUqQg8ppbHqrnwPNEcj2FI0eP29gzY,319
-cfn_check/cli/utils/files.py,sha256=W2lf42qAlTOJ-YJeBWsK99FjnsxZtmit241cLyURg2A,1448
+cfn_check/cli/utils/attributes.py,sha256=iIUIgl6cT5XEUOW7D54-xxmMpTis84ySQY1b9osB47E,339
+cfn_check/cli/utils/files.py,sha256=pkN-3jqI2cwiCBhnKYmaoEPqFw_qypOhKlLk-SvINFw,2557
+cfn_check/collection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cfn_check/collection/collection.py,sha256=wNxahoOqQge3C56blz5VtOq6lX5MZ9F2JjQIyZ3_SxU,27
 cfn_check/evaluation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfn_check/evaluation/check.py,sha256=5GgoZY0YfyOeOP92VJVH4Y3AYB7jUGjxwsr0qsbVGeo,414
 cfn_check/evaluation/errors.py,sha256=yPJdtRYo67le4yMC9sYqcboCnkqKsJ3KPbSPFY2-Pi8,773
@@ -16,15 +18,14 @@ cfn_check/logging/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU
 cfn_check/logging/models.py,sha256=-tBaK6p8mJ0cO8h2keEJ-VmtFX_VW4XzwAw2PtqbkF0,490
 cfn_check/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfn_check/rules/rule.py,sha256=r6-eKCUdPaNIena2NDv3J_QlcWes1KLObI9ukRZZz1o,500
-cfn_check/rules/rules.py,sha256=d7VvF6nlXER1puY9lEbQjFQv7RJMmD-wF4RoDCm8mQ0,22
 cfn_check/shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfn_check/shared/types.py,sha256=-om3DyZsjK_tJd-I8SITkoE55W0nB2WA3LOc87Cs7xI,414
 cfn_check/validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfn_check/validation/validator.py,sha256=FGPeb8Uc8lvX3Y5rs-fxeJKIOqzUXwXh_gCFcy6d3b0,1182
-cfn_check-0.1.1.dist-info/licenses/LICENSE,sha256=EbCpGNzOkyQ53ig7J2Iwgmy4Og0dgHe8COo3WylhIKk,1069
-example/rules.py,sha256=gEAX52iK76XBdfiilqfqnxh6j8rACp7v7dwbb_EQ-1o,359
-cfn_check-0.1.1.dist-info/METADATA,sha256=26wu7hNXHtzg6hAZer8_lNcNFRM9mJ_R2Ji1JkW-jd4,8447
-cfn_check-0.1.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-cfn_check-0.1.1.dist-info/entry_points.txt,sha256=B4lCHoDHmwisABxKgRLShwqqFv7QwwDAFXoAChOnkwg,53
-cfn_check-0.1.1.dist-info/top_level.txt,sha256=hUn9Ya50yY1fpgWxEhG5iMgfMDDVX7qWQnM1xrgZnhM,18
-cfn_check-0.1.1.dist-info/RECORD,,
+cfn_check-0.2.1.dist-info/licenses/LICENSE,sha256=EbCpGNzOkyQ53ig7J2Iwgmy4Og0dgHe8COo3WylhIKk,1069
+example/rules.py,sha256=XVsOkY5gxEier6oVyMVwuJ3ftwbv987udEkg2qZe_Zs,369
+cfn_check-0.2.1.dist-info/METADATA,sha256=c7EmyUA8rmPum59hiaXuyULhPWlrQVbwxssUl3Obgt0,8472
+cfn_check-0.2.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+cfn_check-0.2.1.dist-info/entry_points.txt,sha256=B4lCHoDHmwisABxKgRLShwqqFv7QwwDAFXoAChOnkwg,53
+cfn_check-0.2.1.dist-info/top_level.txt,sha256=hUn9Ya50yY1fpgWxEhG5iMgfMDDVX7qWQnM1xrgZnhM,18
+cfn_check-0.2.1.dist-info/RECORD,,

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/rules/rules.py

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