{"id":44752670,"url":"https://github.com/srichs/saneconfig","last_synced_at":"2026-02-15T23:16:31.638Z","repository":{"id":338403965,"uuid":"1157754949","full_name":"srichs/saneconfig","owner":"srichs","description":"Dead-simple typed config loader for dataclasses with great errors and provenance.","archived":false,"fork":false,"pushed_at":"2026-02-14T15:40:33.000Z","size":79,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-14T17:05:33.796Z","etag":null,"topics":["config","configuration","dataclasses","dotenv","environment-variables","python","settings","toml"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/saneconfig/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/srichs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-14T08:39:23.000Z","updated_at":"2026-02-14T16:04:02.000Z","dependencies_parsed_at":"2026-02-14T17:05:35.411Z","dependency_job_id":null,"html_url":"https://github.com/srichs/saneconfig","commit_stats":null,"previous_names":["srichs/saneconfig"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/srichs/saneconfig","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srichs%2Fsaneconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srichs%2Fsaneconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srichs%2Fsaneconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srichs%2Fsaneconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srichs","download_url":"https://codeload.github.com/srichs/saneconfig/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srichs%2Fsaneconfig/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29492029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T19:29:10.908Z","status":"ssl_error","status_checked_at":"2026-02-15T19:29:10.419Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","configuration","dataclasses","dotenv","environment-variables","python","settings","toml"],"created_at":"2026-02-15T23:16:31.056Z","updated_at":"2026-02-15T23:16:31.633Z","avatar_url":"https://github.com/srichs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# saneconfig\n\n[![CI](https://github.com/srichs/saneconfig/actions/workflows/ci.yml/badge.svg)](https://github.com/srichs/saneconfig/actions/workflows/ci.yml)\n[![Docs](https://img.shields.io/github/actions/workflow/status/srichs/saneconfig/ci.yml?branch=main\u0026label=docs)](https://github.com/srichs/saneconfig/actions/workflows/ci.yml)\n[![PyPI](https://img.shields.io/pypi/v/saneconfig.svg)](https://pypi.org/project/saneconfig/)\n\nDead-simple typed config loader for **dataclasses**:\n- defaults\n- TOML file(s)\n- environment variables\n\nwith **great errors** and **provenance** (\"where did this value come from?\").\n\nPython **3.11+**.\n\nCore package has zero runtime dependencies; optional extras:\n- `saneconfig[dotenv]` for `.env` file support.\n\n## Install\n\n```bash\npip install saneconfig\n# optional .env support\npip install \"saneconfig[dotenv]\"\n```\n\n## Quick start\n\n```python\nfrom dataclasses import dataclass\nfrom saneconfig import load, REQUIRED\n\n\n@dataclass\nclass AppConfig:\n    debug: bool = False\n    port: int = 8080\n    database_url: str = REQUIRED\n\n\ncfg = load(\n    AppConfig,\n    env_prefix=\"APP\",\n    files=[\"config.toml\", \"config.local.toml\"],\n)\n\nprint(cfg.port)\n```\n\n## Precedence (highest wins)\n\n1. CLI args (`argv=True` or `argv=[...]`)\n2. Environment variables\n3. `.env` file values (when `dotenv` is enabled)\n4. TOML files (later overrides earlier)\n5. Dataclass defaults\n\n## TOML example\n\n```toml\ndebug = true\nport = 9000\ndatabase_url = \"postgresql://user:pass@localhost:5432/mydb\"\n```\n\nNested dataclasses map to TOML tables:\n\n```toml\n[db]\nhost = \"localhost\"\nport = 5432\n```\n\n## Env var mapping\n\nWith `env_prefix=\"APP\"`:\n\n- `APP_PORT=9000` -\u003e `port`\n- `APP_DEBUG=true` -\u003e `debug`\n- nested via `__`: `APP_DB__HOST=localhost` -\u003e `db.host`\n\nBooleans accept: `true/false`, `yes/no`, `on/off`, `1/0` (case-insensitive).\n\nLists in env vars use JSON:\n\n```bash\nAPP_ALLOWED='[\"a\",\"b\"]'\n```\n\n\n## CLI overrides\n\nEnable CLI parsing by passing `argv=True` (uses `sys.argv[1:]`) or provide a list explicitly:\n\n```python\ncfg = load(\n    AppConfig,\n    env_prefix=\"APP\",\n    argv=[\"--port=9001\", \"--db.host=db.internal\"],\n)\n```\n\nSupported form: `--key=value` with dotted nesting (`--db.host=x`).\n\n## Provenance / debugging\n\n```python\ncfg, report = load(\n    AppConfig,\n    env_prefix=\"APP\",\n    files=[\"config.toml\", \"config.local.toml\"],\n    return_report=True,\n)\n\nprint(report)\n```\n\nExample output:\n\n```text\ndatabase_url='postgresql://...' (env:APP_DATABASE_URL)\ndebug=False (default)\nport=9000 (file:config.toml)\n```\n\n## Schema docs\n\nYou can include richer docs using dataclass metadata:\n\n```python\nfrom dataclasses import dataclass, field\n\n@dataclass\nclass AppConfig:\n    port: int = field(default=8080, metadata={\"help\": \"HTTP listen port\"})\n```\n\n```python\nfrom saneconfig import dump_schema\nprint(dump_schema(AppConfig, env_prefix=\"APP\"))\n```\n\n`dump_schema(...)` includes a `Help` column using `field(metadata={\"help\": ...})`.\n\n## Errors that help\n\nIf a value cannot be converted:\n\n```text\nConfigError: port expected int but got \"eighty\"\n  source: env:APP_PORT\n  hint: Use a valid int value.\n```\n\nIf required values are missing:\n\n```text\nConfigError: missing required configuration values:\n  - database_url\n```\n\n## Supported types (v0.1)\n\n- `str`, `int`, `float`, `bool`\n- `Optional[T]`\n- `list[T]` (TOML arrays or JSON arrays in env)\n- `Literal[...]`\n- nested dataclasses\n- `pathlib.Path`\n- `dict[str, T]` (TOML table or JSON object in env)\n\n## Non-goals (by design)\n\n- profiles/composition systems\n- interpolation DSLs\n- frameworks and global state\n\nMIT Licensed.\n\n---\n\n## A tiny example you can run\n\n```python\nfrom dataclasses import dataclass\nfrom typing import Literal, Optional\n\nfrom saneconfig import REQUIRED, load\n\n\n@dataclass\nclass DB:\n    host: str = \"localhost\"\n    port: int = 5432\n\n\n@dataclass\nclass App:\n    mode: Literal[\"dev\", \"prod\"] = \"dev\"\n    debug: bool = False\n    port: int = 8080\n    api_key: str = REQUIRED\n    db: DB = DB()\n    notes: Optional[str] = None\n\n\ncfg, report = load(App, env_prefix=\"APP\", files=[\"config.toml\"], return_report=True)\nprint(cfg)\nprint(report)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrichs%2Fsaneconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrichs%2Fsaneconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrichs%2Fsaneconfig/lists"}