envproof 0.1.0__py3-none-any.whl

envguard/__init__.py

@@ -0,0 +1,4 @@
+from .core import EnvGuard, EnvGuardError, guard
+
+__all__ = ["EnvGuard", "EnvGuardError", "guard"]
+__version__ = "0.1.0"

envguard/core.py

@@ -0,0 +1,84 @@
+import os
+from typing import Any, get_type_hints
+
+_MISSING = object()
+
+
+class EnvGuardError(Exception):
+    pass
+
+
+class EnvGuard:
+    """
+    Subclass this and declare your env vars as type-annotated class attributes.
+
+    Required var:   DATABASE_URL: str
+    Optional var:   PORT: int = 8080
+    """
+
+    def __init__(self):
+        hints = get_type_hints(self.__class__)
+        missing = []
+        invalid = []
+
+        for name, type_ in hints.items():
+            if name.startswith("_"):
+                continue
+
+            raw = os.environ.get(name)
+            has_default = name in self.__class__.__dict__
+            default = self.__class__.__dict__.get(name, _MISSING)
+
+            if raw is None:
+                if not has_default:
+                    missing.append((name, type_))
+                else:
+                    setattr(self, name, default)
+                continue
+
+            try:
+                setattr(self, name, _coerce(raw, type_))
+            except (ValueError, TypeError):
+                invalid.append((name, type_.__name__, raw))
+
+        errors = []
+        if missing:
+            errors.append("Missing required environment variables:")
+            for name, type_ in missing:
+                errors.append(f"  - {name} ({type_.__name__}): not set")
+        if invalid:
+            if errors:
+                errors.append("")
+            errors.append("Invalid environment variable values:")
+            for name, type_name, raw in invalid:
+                errors.append(f"  - {name}: expected {type_name}, got '{raw}'")
+
+        if errors:
+            raise EnvGuardError("\n" + "\n".join(errors))
+
+
+def _coerce(value: str, type_: type) -> Any:
+    if type_ is bool:
+        if value.lower() in ("true", "1", "yes", "on"):
+            return True
+        if value.lower() in ("false", "0", "no", "off"):
+            return False
+        raise ValueError(f"Cannot convert to bool: {value!r}")
+    if type_ is list:
+        return [v.strip() for v in value.split(",") if v.strip()]
+    return type_(value)
+
+
+def guard(**schema) -> Any:
+    """
+    One-liner usage without subclassing:
+
+        env = guard(DATABASE_URL=str, PORT=int, DEBUG=bool)
+        print(env.DATABASE_URL)
+    """
+
+    class _Env(EnvGuard):
+        pass
+
+    _Env.__annotations__ = schema
+    return _Env()

envproof-0.1.0.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: envproof
+Version: 0.1.0
+Summary: Validate environment variables at startup with typed, clear error messages. Zero dependencies.
+Project-URL: Homepage, https://github.com/CoderSufiyan/envguard
+Project-URL: Repository, https://github.com/CoderSufiyan/envguard
+Project-URL: Issues, https://github.com/CoderSufiyan/envguard/issues
+License: MIT
+Keywords: config,dotenv,env,environment,settings,validation
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# envguard
+
+Validate environment variables at startup with typed, clear error messages. Zero dependencies.
+
+```python
+from envguard import EnvGuard
+
+class Env(EnvGuard):
+    DATABASE_URL: str
+    PORT: int = 8080
+    DEBUG: bool = False
+    ALLOWED_HOSTS: list = []
+
+env = Env()
+print(env.PORT)  # 8080 (int, not string)
+```
+
+If `DATABASE_URL` is missing, you get this instead of a cryptic `KeyError` somewhere deep in your app:
+
+```
+EnvGuardError:
+Missing required environment variables:
+  - DATABASE_URL (str): not set
+```
+
+## Install
+
+```bash
+pip install envguard
+```
+
+## Usage
+
+### Subclass style (recommended)
+
+```python
+from envguard import EnvGuard
+
+class Env(EnvGuard):
+    # Required — raises if not set
+    DATABASE_URL: str
+    API_KEY: str
+
+    # Optional — uses default if not set
+    PORT: int = 8080
+    DEBUG: bool = False
+    LOG_LEVEL: str = "INFO"
+    ALLOWED_HOSTS: list = []
+
+env = Env()
+```
+
+### One-liner style
+
+```python
+from envguard import guard
+
+env = guard(DATABASE_URL=str, PORT=int, DEBUG=bool)
+print(env.DATABASE_URL)
+```
+
+## Supported types
+
+| Type    | Example env value         | Python value             |
+|---------|---------------------------|--------------------------|
+| `str`   | `"hello"`                 | `"hello"`                |
+| `int`   | `"8080"`                  | `8080`                   |
+| `float` | `"3.14"`                  | `3.14`                   |
+| `bool`  | `"true"`, `"1"`, `"yes"`  | `True`                   |
+| `bool`  | `"false"`, `"0"`, `"no"`  | `False`                  |
+| `list`  | `"a,b,c"`                 | `["a", "b", "c"]`        |
+
+## Error messages
+
+All errors are collected and reported together — you won't fix one missing var only to discover another:
+
+```
+EnvGuardError:
+Missing required environment variables:
+  - DATABASE_URL (str): not set
+  - API_KEY (str): not set
+
+Invalid environment variable values:
+  - PORT: expected int, got 'abc'
+  - DEBUG: expected bool, got 'maybe'
+```
+
+## Why not pydantic-settings?
+
+`pydantic-settings` is great but pulls in Pydantic as a dependency (~2MB). `envguard` is a single file with zero dependencies — useful when you want validation without adding weight to your project.
+
+## License
+
+MIT

envproof-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+envguard/__init__.py,sha256=Hd4HRBh0brb7sAxI6TrOZd9fxkvfrLhpArYgVIc97iE,121
+envguard/core.py,sha256=C52SdIjUFC6PB4-_tVHAhezTMJw0Rb9TUu-Rvcnhll4,2328
+envproof-0.1.0.dist-info/METADATA,sha256=dIZBj7jlLKtNDqUE4AUrkgtQIgmCSbpX8CHxbZ0eUsw,3232
+envproof-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+envproof-0.1.0.dist-info/RECORD,,

envproof-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any