{"id":16695720,"url":"https://github.com/henryivesjones/cattrs-env","last_synced_at":"2025-07-04T18:11:08.083Z","repository":{"id":188787506,"uuid":"679353472","full_name":"henryivesjones/cattrs-env","owner":"henryivesjones","description":"A tool for parsing and validating env vars using cattrs","archived":false,"fork":false,"pushed_at":"2023-08-25T15:36:31.000Z","size":10,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-18T00:48:15.127Z","etag":null,"topics":["attrs","cattrs","dataclasses","dotenv","environment-variables","mit-license","python","validation"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/cattrs-env/","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/henryivesjones.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}},"created_at":"2023-08-16T16:40:11.000Z","updated_at":"2023-08-24T13:31:34.000Z","dependencies_parsed_at":"2023-08-16T22:02:05.723Z","dependency_job_id":"ea6cf3cc-339f-4f38-870c-7e02c45c4d94","html_url":"https://github.com/henryivesjones/cattrs-env","commit_stats":{"total_commits":6,"total_committers":2,"mean_commits":3.0,"dds":"0.33333333333333337","last_synced_commit":"42720362cf104ce132ee3c0bbf7d7d486b85bfde"},"previous_names":["henryivesjones/cattrs-env"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/henryivesjones/cattrs-env","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryivesjones%2Fcattrs-env","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryivesjones%2Fcattrs-env/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryivesjones%2Fcattrs-env/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryivesjones%2Fcattrs-env/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/henryivesjones","download_url":"https://codeload.github.com/henryivesjones/cattrs-env/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryivesjones%2Fcattrs-env/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260604337,"owners_count":23035265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["attrs","cattrs","dataclasses","dotenv","environment-variables","mit-license","python","validation"],"created_at":"2024-10-12T17:08:14.980Z","updated_at":"2025-07-04T18:11:08.065Z","avatar_url":"https://github.com/henryivesjones.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cattrs-env\n![Tests + Linting](https://github.com/henryivesjones/cattrs-env/actions/workflows/checks.yml/badge.svg?branch=main\u0026event=push)\n![pypi](https://img.shields.io/pypi/v/cattrs-env)\n![License](https://img.shields.io/pypi/l/cattrs-env)\n![Downloads](https://img.shields.io/pypi/dm/cattrs-env)\n\n\n`cattrs-env` is an Environment Variable parser/validator which utilizes the [`cattrs`](https://github.com/python-attrs/cattrs) library.\n\n`cattrs-env` parses Environment Variables from `os.environ` and structures them into a [`cattrs` compatible dataclass](https://catt.rs/en/stable/structuring.html#simple-attrs-classes-and-dataclasses). Providing you with easy and type safe environment variables in your project.\n\nBecause `cattrs-env` gets the Environment Variables from `os.environ`, it is fully compatible with any Environment Variable loading library such as [`python-dotenv`](https://github.com/theskumar/python-dotenv).\n\n```python\nfrom dataclasses import dataclass\nfrom typing import List, Optional\nfrom cattrs_env import CattrsEnv\n\n@dataclass\nclass Env(CattrsEnv):\n    A: int\n    C: List[str]\n    B: Optional[float] = None\n\nenv = Env.load()\n\nenv.A\nenv.C\nenv.B\n```\n\n# Examples\n\n## dataclass example\n```python\nimport os\nfrom dataclasses import dataclass\nfrom typing import List, Optional\n\nfrom cattrs_env import CattrsEnv\n\n\n@dataclass\nclass Env(CattrsEnv):\n    A: int\n    C: List[str]\n    B: Optional[float] = None\n\n\nif __name__ == \"__main__\":\n    os.environ.update(\n        {\n            \"A\": \"99\",\n            \"B\": \"9.9\",\n            \"C\": '[\"a\",\"b\",\"c\", 1]',\n        }\n    )\n    env = Env.load()\n    print(env)\n```\n\n## attrs example\n```python\nimport os\nfrom typing import List, Optional\nimport attrs\nfrom cattrs_env import CattrsEnv\n\n\n@attrs.define\nclass Config:\n    E: str\n    F: Optional[int] = None\n\n\n@attrs.define\nclass Env(CattrsEnv):\n    A: int\n    C: List[str]\n    D: Config\n    B: Optional[float] = None\n\n\nif __name__ == \"__main__\":\n    os.environ.update(\n        {\n            \"A\": \"99\",\n            \"B\": \"9.9\",\n            \"C\": '[\"a\",\"b\",\"c\", 1]',\n            \"D\": \"\"\"{'E':\"abcdef\"}\"\"\",\n        }\n    )\n    env = Env.load()\n```\n## python-dotenv example\n```python\nfrom dataclasses import dataclass\nfrom typing import List, Optional\nimport dotenv\nfrom cattrs_env import CattrsEnv\n\n\n@dataclass\nclass Env(CattrsEnv):\n    A: int\n    C: List[str]\n    B: Optional[float] = None\n\n\nENV_FILE_CONTENTS = \"\"\"\nA=1\nB=99.9\nC=\"['foo', 'bar']\"\n\"\"\"\n\nif __name__ == \"__main__\":\n    with open(\".env\", \"w\") as env_file:\n        env_file.write(ENV_FILE_CONTENTS)\n    dotenv.load_dotenv()\n    env = Env.load()\n    print(env)\n\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhenryivesjones%2Fcattrs-env","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhenryivesjones%2Fcattrs-env","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhenryivesjones%2Fcattrs-env/lists"}