https://github.com/yukinarit/envclasses

envclasses is a library to map fields on dataclass object to environment variables.
https://github.com/yukinarit/envclasses

dataclasses env environment-variables python

Last synced: 10 days ago
JSON representation

envclasses is a library to map fields on dataclass object to environment variables.

• Host: GitHub
• URL: https://github.com/yukinarit/envclasses
• Owner: yukinarit
• License: mit
• Created: 2018-10-17T15:11:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-10-18T13:33:59.000Z (over 2 years ago)
• Last Synced: 2024-10-29T21:10:28.684Z (6 months ago)
• Topics: dataclasses, env, environment-variables, python
• Language: Python
• Homepage: https://yukinarit.github.io/envclasses/envclasses.html
• Size: 149 KB
• Stars: 31
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `envclasses`

[![image](https://img.shields.io/pypi/v/envclasses.svg)](https://pypi.org/project/envclasses/)

[![image](https://img.shields.io/pypi/pyversions/envclasses.svg)](https://pypi.org/project/envclasses/)

![Test](https://github.com/yukinarit/envclasses/workflows/Test/badge.svg)

*`envclasses` is a library to map fields on dataclass object to environment variables.*

## Installation

```bash

pip install envclasses

```

## Usage

Declare a class with `dataclass` and `envclass` decorators.

```python

from envclasses import envclass, load_env

from dataclasses import dataclass

@envclass

@dataclass

class Foo:

    v: int

foo = Foo(v=10)

load_env(foo, prefix='foo')

print(foo)

```

Run the script

```

$ python foo.py

Foo(v=10)

```

Run with environment variable

```

$ FOO_V=100 python foo.py

Foo(v=100)

```