secure-credentials-kit 0.2.0__tar.gz → 0.3.0__tar.gz

{secure_credentials_kit-0.2.0/secure_credentials_kit.egg-info → secure_credentials_kit-0.3.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: secure-credentials-kit
-Version: 0.2.0
+Version: 0.3.0
 Summary: A secure encrypted credentials system for Django and FastAPI, inspired by Rails credentials
 License-Expression: MIT
-Project-URL: Homepage, https://github.com/lexpank/django-secure-credentials-kit
-Project-URL: Issues, https://github.com/lexpank/django-secure-credentials-kit/issues
+Project-URL: Homepage, https://github.com/lexpank/secure-credentials-kit
+Project-URL: Issues, https://github.com/lexpank/secure-credentials-kit/issues
 Keywords: django,fastapi,credentials,encryption,security
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -231,3 +231,15 @@ credentials.dig('key', 'subkey')
 ```
 
 for complex nested credentials.
+
+To access and cast a credential:
+
+```python
+credentials.get_as_type('port', int)
+```
+
+or
+
+```python
+credentials.dig_as_type(int, 'database', 'port')
+```

{secure_credentials_kit-0.2.0 → secure_credentials_kit-0.3.0}/README.md

@@ -201,3 +201,15 @@ credentials.dig('key', 'subkey')
 ```
 
 for complex nested credentials.
+
+To access and cast a credential:
+
+```python
+credentials.get_as_type('port', int)
+```
+
+or
+
+```python
+credentials.dig_as_type(int, 'database', 'port')
+```

{secure_credentials_kit-0.2.0 → secure_credentials_kit-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "secure-credentials-kit"
-version = "0.2.0"
+version = "0.3.0"
 description = "A secure encrypted credentials system for Django and FastAPI, inspired by Rails credentials"
 readme = "README.md"
 requires-python = ">=3.10,<3.15"
@@ -39,8 +39,8 @@ secure-credentials-kit-edit = "secure_credentials_kit.cli:edit_main"
 secure-credentials-kit-generate-key = "secure_credentials_kit.cli:generate_key_main"
 
 [project.urls]
-Homepage = "https://github.com/lexpank/django-secure-credentials-kit"
-Issues = "https://github.com/lexpank/django-secure-credentials-kit/issues"
+Homepage = "https://github.com/lexpank/secure-credentials-kit"
+Issues = "https://github.com/lexpank/secure-credentials-kit/issues"
 
 [tool.setuptools.packages.find]
 exclude = ["tests", "examples"]

{secure_credentials_kit-0.2.0 → secure_credentials_kit-0.3.0}/secure_credentials_kit/secrets_loader.py

@@ -1,7 +1,11 @@
 from os import path
+from typing import TypeVar
+
 from secure_credentials_kit.credentials import read_key, resolve_read_key_path, secret_path
 from secure_credentials_kit.utils import decrypt_credentials_data
 
+T = TypeVar("T")
+
 
 def normalize_credentials(credentials):
     if credentials is None:
@@ -35,6 +39,20 @@ class CredentialsContainer(object):
     def get(self, key: str, default=None):
         return self._credentials.get(key, default)
 
+    def get_as_type(self, key: str, output_type: type[T], default=None) -> T:
+        value = self.get(key, default)
+        if value is None:
+            return None
+        return output_type(value)
+
+    def dig_as_type(self, output_type: type[T], *args, default=None) -> T:
+        value = self.dig(*args)
+        if value is None:
+            value = default
+        if value is None:
+            return None
+        return output_type(value)
+
 
 def decrypt_credentials(env: str, secrets_dir: str = "secrets") -> CredentialsContainer:
     """ Decrypt credentials """

{secure_credentials_kit-0.2.0 → secure_credentials_kit-0.3.0/secure_credentials_kit.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: secure-credentials-kit
-Version: 0.2.0
+Version: 0.3.0
 Summary: A secure encrypted credentials system for Django and FastAPI, inspired by Rails credentials
 License-Expression: MIT
-Project-URL: Homepage, https://github.com/lexpank/django-secure-credentials-kit
-Project-URL: Issues, https://github.com/lexpank/django-secure-credentials-kit/issues
+Project-URL: Homepage, https://github.com/lexpank/secure-credentials-kit
+Project-URL: Issues, https://github.com/lexpank/secure-credentials-kit/issues
 Keywords: django,fastapi,credentials,encryption,security
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -231,3 +231,15 @@ credentials.dig('key', 'subkey')
 ```
 
 for complex nested credentials.
+
+To access and cast a credential:
+
+```python
+credentials.get_as_type('port', int)
+```
+
+or
+
+```python
+credentials.dig_as_type(int, 'database', 'port')
+```

{secure_credentials_kit-0.2.0 → secure_credentials_kit-0.3.0}/tests/test_packaging.py

@@ -17,7 +17,7 @@ class SetupMetadataTests(unittest.TestCase):
         metadata = self.load_project_metadata()["project"]
 
         self.assertEqual(metadata["name"], "secure-credentials-kit")
-        self.assertEqual(metadata["version"], "0.2.0")
+        self.assertEqual(metadata["version"], "0.3.0")
         self.assertEqual(metadata["requires-python"], ">=3.10,<3.15")
 
     def test_django_and_fastapi_are_optional_extras(self):

secure_credentials_kit-0.3.0/tests/test_secrets_loader.py

@@ -0,0 +1,70 @@
+import unittest
+
+from secure_credentials_kit.secrets_loader import CredentialsContainer, normalize_credentials
+
+
+class CredentialsContainerTests(unittest.TestCase):
+    def test_empty_credentials_are_normalized_to_dict(self):
+        container = CredentialsContainer(None)
+
+        self.assertIsNone(container.get("SOME_ENV_VAR"))
+
+    def test_mapping_credentials_support_get_and_dig(self):
+        container = CredentialsContainer({"database": {"url": "postgres://example"}})
+
+        self.assertEqual(container.get("database"), {"url": "postgres://example"})
+        self.assertEqual(container.dig("database", "url"), "postgres://example")
+
+    def test_string_credentials_raise_clear_error(self):
+        with self.assertRaisesRegex(ValueError, "mapping at the root"):
+            CredentialsContainer("SOME_ENV_VAR=secret")
+
+    def test_list_credentials_raise_clear_error(self):
+        with self.assertRaisesRegex(ValueError, "mapping at the root"):
+            normalize_credentials(["secret"])
+
+    def test_get_as_type_casts_existing_value(self):
+        container = CredentialsContainer({"port": "5432"})
+
+        self.assertEqual(container.get_as_type("port", int), 5432)
+
+    def test_get_as_type_returns_default_cast_to_type(self):
+        container = CredentialsContainer({})
+
+        self.assertEqual(container.get_as_type("port", int, "5432"), 5432)
+
+    def test_get_as_type_returns_none_for_missing_value_without_default(self):
+        container = CredentialsContainer({})
+
+        self.assertIsNone(container.get_as_type("port", int))
+
+    def test_get_as_type_returns_cast_errors(self):
+        container = CredentialsContainer({"port": "invalid"})
+
+        with self.assertRaises(ValueError):
+            container.get_as_type("port", int)
+
+    def test_dig_as_type_casts_existing_value(self):
+        container = CredentialsContainer({"database": {"port": "5432"}})
+
+        self.assertEqual(container.dig_as_type(int, "database", "port"), 5432)
+
+    def test_dig_as_type_returns_default_cast_to_type(self):
+        container = CredentialsContainer({})
+
+        self.assertEqual(container.dig_as_type(int, "database", "port", default="5432"), 5432)
+
+    def test_dig_as_type_returns_none_for_missing_value_without_default(self):
+        container = CredentialsContainer({})
+
+        self.assertIsNone(container.dig_as_type(int, "database", "port"))
+
+    def test_dig_as_type_returns_cast_errors(self):
+        container = CredentialsContainer({"database": {"port": "invalid"}})
+
+        with self.assertRaises(ValueError):
+            container.dig_as_type(int, "database", "port")
+
+
+if __name__ == "__main__":
+    unittest.main()

secure_credentials_kit-0.2.0/tests/test_secrets_loader.py

@@ -1,28 +0,0 @@
-import unittest
-
-from secure_credentials_kit.secrets_loader import CredentialsContainer, normalize_credentials
-
-
-class CredentialsContainerTests(unittest.TestCase):
-    def test_empty_credentials_are_normalized_to_dict(self):
-        container = CredentialsContainer(None)
-
-        self.assertIsNone(container.get("SOME_ENV_VAR"))
-
-    def test_mapping_credentials_support_get_and_dig(self):
-        container = CredentialsContainer({"database": {"url": "postgres://example"}})
-
-        self.assertEqual(container.get("database"), {"url": "postgres://example"})
-        self.assertEqual(container.dig("database", "url"), "postgres://example")
-
-    def test_string_credentials_raise_clear_error(self):
-        with self.assertRaisesRegex(ValueError, "mapping at the root"):
-            CredentialsContainer("SOME_ENV_VAR=secret")
-
-    def test_list_credentials_raise_clear_error(self):
-        with self.assertRaisesRegex(ValueError, "mapping at the root"):
-            normalize_credentials(["secret"])
-
-
-if __name__ == "__main__":
-    unittest.main()