tidyenv 0.1.0__tar.gz

tidyenv-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# Opens one monthly PR that bumps the GitHub Actions used in .github/workflows.
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      actions:
+        patterns: ["*"]

tidyenv-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run mypy
+      - run: uv run pytest

tidyenv-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,69 @@
+# Publishing, with no tokens (PyPI "trusted publishing"):
+#   - Run this workflow by hand (Actions -> Release -> Run workflow) to publish to TestPyPI.
+#   - Publish a GitHub release with tag vX.Y.Z to publish to PyPI.
+# One-time setup on pypi.org and test.pypi.org: add a trusted publisher with
+# owner LenaBarretta, repository tidyenv, workflow release.yml and environment
+# `pypi` (on pypi.org) or `testpypi` (on test.pypi.org).
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+      - run: uv build
+      - name: Check that the release tag matches the package version
+        if: github.event_name == 'release'
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          test -f "dist/tidyenv-${version}-py3-none-any.whl" || {
+            echo "Tag $GITHUB_REF_NAME does not match the version in src/tidyenv/__init__.py"
+            ls dist
+            exit 1
+          }
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          # A version can be uploaded only once; reruns just re-check the setup.
+          skip-existing: true
+
+  pypi:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

tidyenv-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.coverage
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.DS_Store

tidyenv-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0 (2026-10-02)
+
+First release: `str`, `int`, `float`, `bool`, `list`, `choice`, `path` and `json`
+readers, defaults, `secret=True`, prefixes, `env.collect()` for all-at-once errors,
+and built-in `.env` loading with `env.read_dotenv()` and `parse_dotenv()`.

tidyenv-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Elena Raikova
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tidyenv-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.5
+Name: tidyenv
+Version: 0.1.0
+Summary: Typed environment variables with friendly errors and built-in .env support.
+Project-URL: Homepage, https://github.com/LenaBarretta/tidyenv
+Project-URL: Issues, https://github.com/LenaBarretta/tidyenv/issues
+Author-email: Elena Raikova <lenabarretta@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: 12-factor,config,env,environment,settings
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/LenaBarretta/tidyenv/main/docs/logo.png" alt="tidyenv logo" width="160">
+</p>
+
+# tidyenv
+
+[![PyPI](https://img.shields.io/pypi/v/tidyenv)](https://pypi.org/project/tidyenv/)
+[![Python](https://img.shields.io/pypi/pyversions/tidyenv)](https://pypi.org/project/tidyenv/)
+[![CI](https://github.com/LenaBarretta/tidyenv/actions/workflows/ci.yml/badge.svg)](https://github.com/LenaBarretta/tidyenv/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**Typed environment variables with friendly errors.** Built-in `.env` support. Zero dependencies.
+
+```python
+from tidyenv import env
+
+PORT = env.int("PORT", default=8000)
+DEBUG = env.bool("DEBUG", default=False)
+HOSTS = env.list("ALLOWED_HOSTS", default=["localhost"])
+DATABASE_URL = env.str("DATABASE_URL")
+```
+
+Each line converts the type, applies the default, and if something is wrong, says exactly what:
+
+```text
+tidyenv.EnvError: 1 environment problem:
+  - PORT: expected an integer (got 'eighty')
+```
+
+## Why
+
+| | Plain `os.environ` | tidyenv |
+| --- | --- | --- |
+| Number with a default | `int(os.environ.get("PORT", "8000"))` | `env.int("PORT", default=8000)` |
+| Bad number | `ValueError: invalid literal for int() with base 10: 'eighty'` (which variable?) | `PORT: expected an integer (got 'eighty')` |
+| Missing variable | `KeyError: 'DB_URL'` | `DB_URL: is not set` |
+| Empty value `DB_URL=` | silently `""` | treated as not set |
+| Boolean | `os.environ.get("DEBUG", "").lower() in ("1", "true", "yes")`, and a typo like `ture` silently means `False` | `env.bool("DEBUG", default=False)`, and `ture` is an error |
+| List | `[h.strip() for h in os.environ.get("HOSTS", "").split(",") if h.strip()]` | `env.list("HOSTS")` |
+| List of numbers | the same, plus `int()` on every item | `env.list("PORTS", of=int)` |
+| One of several values | `if mode not in ("dev", "prod"): raise ...` | `env.choice("MODE", ["dev", "prod"])` |
+| Secrets in errors | the value ends up in your logs | `secret=True` shows `***` |
+| `.env` file | `pip install python-dotenv` + `load_dotenv()` | `env.read_dotenv()`, nothing to install |
+| Types for mypy / IDE | `str \| None`, cast it yourself | `env.int` returns `int` |
+| Several broken variables | crash, fix, redeploy, crash on the next one | `env.collect()` lists them all at once |
+
+One line per variable, and every error names the variable and says what is wrong with it.
+
+## Install
+
+```bash
+pip install tidyenv
+```
+
+Python 3.9+.
+
+## Usage
+
+| Reader | Example value | Returns |
+| --- | --- | --- |
+| `env.str(name)` | `hello` | `str` (stripped) |
+| `env.int(name)` | `8000`, `1_000` | `int` |
+| `env.float(name)` | `0.25` | `float` (`nan` and `inf` are rejected) |
+| `env.bool(name)` | `true/false`, `yes/no`, `on/off`, `1/0`, any case | `bool` |
+| `env.list(name, sep=",", of=str)` | `a, b, c` | `list` (use `of=int` to convert items; `int`, `float` and `bool` follow the rules above) |
+| `env.choice(name, choices)` | `prod` | `str` that must be in `choices` |
+| `env.path(name, must_exist=False)` | `~/data` | `pathlib.Path` with `~` expanded |
+| `env.json(name)` | `{"a": 1}` | parsed JSON |
+
+Every reader takes an optional `default`. Without one, a missing or empty variable is
+an error. With one, the default is returned instead, and type checkers know the result
+is `int | <type of default>`.
+
+### `.env` files
+
+No need for `python-dotenv`:
+
+```python
+env.read_dotenv()  # reads ./.env if it exists
+env.read_dotenv("config/dev.env", required=True)
+```
+
+Real environment variables always win over the file, and nothing is written to
+`os.environ`. When you read several files, later ones override earlier ones.
+Supported syntax: `KEY=value`, `export KEY=value`, `# comments`,
+`'single quotes'` (literal) and `"double quotes"` (with `\n`, `\t`, `\"` escapes).
+Each value must fit on one line; for a multi-line value such as a PEM key, write
+`\n` inside double quotes.
+Need just the parser? `tidyenv.parse_dotenv(text)` returns a `dict`.
+
+### All errors at once (optional)
+
+By default the first bad variable raises `EnvError`. If you'd rather see every
+problem in one go, wrap your reads in `env.collect()`:
+
+```python
+with env.collect():
+    PORT = env.int("PORT", default=8000)
+    DATABASE_URL = env.str("DATABASE_URL")
+    API_KEY = env.str("API_KEY", secret=True)
+```
+
+```text
+tidyenv.EnvError: 3 environment problems:
+  - PORT: expected an integer (got 'eighty')
+  - DATABASE_URL: is not set
+  - API_KEY: is not set
+```
+
+Failed reads return `None` inside the block, so only use the values after it exits.
+
+### More
+
+**Secrets.** Pass `secret=True` and the raw value is shown as `***` in error messages,
+including errors about single `env.list` items.
+
+**Prefixes and custom sources.** Build your own reader:
+
+```python
+from tidyenv import Env
+
+env = Env(prefix="MYAPP_")  # reads MYAPP_PORT for env.int("PORT")
+test_env = Env(environ={"PORT": "1"})  # any mapping, handy in tests
+```
+
+**Handling errors.** `EnvError.problems` is a list of `Problem(name, message)`, so you
+can print them your own way.
+
+## License
+
+MIT

tidyenv-0.1.0/README.md

@@ -0,0 +1,131 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/LenaBarretta/tidyenv/main/docs/logo.png" alt="tidyenv logo" width="160">
+</p>
+
+# tidyenv
+
+[![PyPI](https://img.shields.io/pypi/v/tidyenv)](https://pypi.org/project/tidyenv/)
+[![Python](https://img.shields.io/pypi/pyversions/tidyenv)](https://pypi.org/project/tidyenv/)
+[![CI](https://github.com/LenaBarretta/tidyenv/actions/workflows/ci.yml/badge.svg)](https://github.com/LenaBarretta/tidyenv/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**Typed environment variables with friendly errors.** Built-in `.env` support. Zero dependencies.
+
+```python
+from tidyenv import env
+
+PORT = env.int("PORT", default=8000)
+DEBUG = env.bool("DEBUG", default=False)
+HOSTS = env.list("ALLOWED_HOSTS", default=["localhost"])
+DATABASE_URL = env.str("DATABASE_URL")
+```
+
+Each line converts the type, applies the default, and if something is wrong, says exactly what:
+
+```text
+tidyenv.EnvError: 1 environment problem:
+  - PORT: expected an integer (got 'eighty')
+```
+
+## Why
+
+| | Plain `os.environ` | tidyenv |
+| --- | --- | --- |
+| Number with a default | `int(os.environ.get("PORT", "8000"))` | `env.int("PORT", default=8000)` |
+| Bad number | `ValueError: invalid literal for int() with base 10: 'eighty'` (which variable?) | `PORT: expected an integer (got 'eighty')` |
+| Missing variable | `KeyError: 'DB_URL'` | `DB_URL: is not set` |
+| Empty value `DB_URL=` | silently `""` | treated as not set |
+| Boolean | `os.environ.get("DEBUG", "").lower() in ("1", "true", "yes")`, and a typo like `ture` silently means `False` | `env.bool("DEBUG", default=False)`, and `ture` is an error |
+| List | `[h.strip() for h in os.environ.get("HOSTS", "").split(",") if h.strip()]` | `env.list("HOSTS")` |
+| List of numbers | the same, plus `int()` on every item | `env.list("PORTS", of=int)` |
+| One of several values | `if mode not in ("dev", "prod"): raise ...` | `env.choice("MODE", ["dev", "prod"])` |
+| Secrets in errors | the value ends up in your logs | `secret=True` shows `***` |
+| `.env` file | `pip install python-dotenv` + `load_dotenv()` | `env.read_dotenv()`, nothing to install |
+| Types for mypy / IDE | `str \| None`, cast it yourself | `env.int` returns `int` |
+| Several broken variables | crash, fix, redeploy, crash on the next one | `env.collect()` lists them all at once |
+
+One line per variable, and every error names the variable and says what is wrong with it.
+
+## Install
+
+```bash
+pip install tidyenv
+```
+
+Python 3.9+.
+
+## Usage
+
+| Reader | Example value | Returns |
+| --- | --- | --- |
+| `env.str(name)` | `hello` | `str` (stripped) |
+| `env.int(name)` | `8000`, `1_000` | `int` |
+| `env.float(name)` | `0.25` | `float` (`nan` and `inf` are rejected) |
+| `env.bool(name)` | `true/false`, `yes/no`, `on/off`, `1/0`, any case | `bool` |
+| `env.list(name, sep=",", of=str)` | `a, b, c` | `list` (use `of=int` to convert items; `int`, `float` and `bool` follow the rules above) |
+| `env.choice(name, choices)` | `prod` | `str` that must be in `choices` |
+| `env.path(name, must_exist=False)` | `~/data` | `pathlib.Path` with `~` expanded |
+| `env.json(name)` | `{"a": 1}` | parsed JSON |
+
+Every reader takes an optional `default`. Without one, a missing or empty variable is
+an error. With one, the default is returned instead, and type checkers know the result
+is `int | <type of default>`.
+
+### `.env` files
+
+No need for `python-dotenv`:
+
+```python
+env.read_dotenv()  # reads ./.env if it exists
+env.read_dotenv("config/dev.env", required=True)
+```
+
+Real environment variables always win over the file, and nothing is written to
+`os.environ`. When you read several files, later ones override earlier ones.
+Supported syntax: `KEY=value`, `export KEY=value`, `# comments`,
+`'single quotes'` (literal) and `"double quotes"` (with `\n`, `\t`, `\"` escapes).
+Each value must fit on one line; for a multi-line value such as a PEM key, write
+`\n` inside double quotes.
+Need just the parser? `tidyenv.parse_dotenv(text)` returns a `dict`.
+
+### All errors at once (optional)
+
+By default the first bad variable raises `EnvError`. If you'd rather see every
+problem in one go, wrap your reads in `env.collect()`:
+
+```python
+with env.collect():
+    PORT = env.int("PORT", default=8000)
+    DATABASE_URL = env.str("DATABASE_URL")
+    API_KEY = env.str("API_KEY", secret=True)
+```
+
+```text
+tidyenv.EnvError: 3 environment problems:
+  - PORT: expected an integer (got 'eighty')
+  - DATABASE_URL: is not set
+  - API_KEY: is not set
+```
+
+Failed reads return `None` inside the block, so only use the values after it exits.
+
+### More
+
+**Secrets.** Pass `secret=True` and the raw value is shown as `***` in error messages,
+including errors about single `env.list` items.
+
+**Prefixes and custom sources.** Build your own reader:
+
+```python
+from tidyenv import Env
+
+env = Env(prefix="MYAPP_")  # reads MYAPP_PORT for env.int("PORT")
+test_env = Env(environ={"PORT": "1"})  # any mapping, handy in tests
+```
+
+**Handling errors.** `EnvError.problems` is a list of `Problem(name, message)`, so you
+can print them your own way.
+
+## License
+
+MIT

tidyenv-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "tidyenv"
+dynamic = ["version"]
+description = "Typed environment variables with friendly errors and built-in .env support."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Elena Raikova", email = "lenabarretta@gmail.com" }]
+requires-python = ">=3.9"
+dependencies = []
+keywords = ["environment", "env", "config", "settings", "12-factor"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/LenaBarretta/tidyenv"
+Issues = "https://github.com/LenaBarretta/tidyenv/issues"
+
+[dependency-groups]
+dev = ["pytest>=8", "pytest-cov>=5", "ruff>=0.6", "mypy>=1.11"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["docs"]
+
+[tool.hatch.version]
+path = "src/tidyenv/__init__.py"
+
+[tool.pytest.ini_options]
+addopts = "-q --cov=tidyenv --cov-report=term-missing --cov-fail-under=100"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "RUF"]
+
+[tool.mypy]
+strict = true
+files = ["src", "tests"]

tidyenv-0.1.0/src/tidyenv/__init__.py

@@ -0,0 +1,13 @@
+"""Typed environment variables with friendly errors and built-in .env support."""
+
+from tidyenv._dotenv import parse_dotenv
+from tidyenv._env import Env, EnvError, Problem
+
+__all__ = ["Env", "EnvError", "Problem", "env", "parse_dotenv"]
+__version__ = "0.1.0"
+
+# Show errors as tidyenv.EnvError, not tidyenv._env.EnvError.
+for _cls in (Env, EnvError, Problem):
+    _cls.__module__ = __name__
+
+env = Env()

tidyenv-0.1.0/src/tidyenv/_dotenv.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+import re
+
+# The value keeps its leading whitespace: `A= # note` is an empty value plus a comment.
+_LINE = re.compile(r"^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_.]*)\s*=(.*?)\s*$")
+_ESCAPES = {"n": "\n", "r": "\r", "t": "\t", '"': '"', "\\": "\\"}
+
+
+def parse_dotenv(text: str) -> dict[str, str]:
+    """Parse the contents of a ``.env`` file into a dict.
+
+    Supports ``KEY=value``, ``export KEY=value``, ``#`` comments, blank lines,
+    'single quotes' (taken literally) and "double quotes" (with ``\\n``, ``\\t``,
+    ``\\"`` and ``\\\\`` escapes). Values must fit on one line.
+    Raises ``ValueError`` naming the bad line.
+    """
+    values: dict[str, str] = {}
+    for lineno, line in enumerate(text.splitlines(), start=1):
+        if not line.strip() or line.lstrip().startswith("#"):
+            continue
+        match = _LINE.match(line)
+        if match is None:
+            raise ValueError(f"line {lineno}: expected KEY=VALUE")
+        key, raw = match.groups()
+        try:
+            values[key] = _value(raw)
+        except ValueError as exc:
+            raise ValueError(f"line {lineno}: {exc}") from None
+    return values
+
+
+def _value(raw: str) -> str:
+    value = raw.lstrip()
+    if value[:1] in ("'", '"'):
+        quote = value[0]
+        end = _closing_quote(value, quote)
+        rest = value[end + 1 :].strip()
+        if rest and not rest.startswith("#"):
+            raise ValueError(f"unexpected text after closing quote: {rest!r}")
+        body = value[1:end]
+        if quote == "'":
+            return body
+        return re.sub(r"\\(.)", lambda m: _ESCAPES.get(m.group(1), m.group(0)), body)
+    # Unquoted: an inline comment needs whitespace before the '#'; the space after
+    # '=' counts, so `A= # note` is empty while `A=#x` is the literal '#x'.
+    return re.split(r"\s+#", raw, maxsplit=1)[0].strip()
+
+
+def _closing_quote(raw: str, quote: str) -> int:
+    i = 1
+    while i < len(raw):
+        if raw[i] == "\\" and quote == '"':
+            i += 2
+            continue
+        if raw[i] == quote:
+            return i
+        i += 1
+    raise ValueError(f"missing closing {quote}")