yukinarit / envclasses Goto Github PK

View Code? Open in Web Editor NEW

31.0 2.0 4.0 153 KB

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

Home Page: https://yukinarit.github.io/envclasses/envclasses.html

License: MIT License

Python 96.58% Makefile 3.42%

dataclasses python env environment-variables

envclasses's Introduction

`envclasses`

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

Installation

pip install envclasses

Usage

Declare a class with dataclass and envclass decorators.

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)

envclasses's People

Contributors

Stargazers

Watchers

Forkers

christosvar alexmisk van51 danidelvalle

envclasses's Issues

Create an instance from env vars

Currently load_env function takes an instance of dataclass.

foo = Foo()
load_env(foo, ...)

This feature extends load_env to accept a class as the first argument and create an instance from env vars

foo = load_env(Foo, ...)

Generate API docs

Just like pyserde does.

Use Github Action

The usage of CircleCI is still very little. I am not an expert on CicleCI, so I want to transfer my projects to using Github Action instead of CircleCI for the same purpose i.e. running tests :)

TypeError: 'ellipsis' object is not callable

I've set up a dataclass envclass, with the following attribute:

RETRIES: tuple[float, ...] = (0.1, 0.5, 2)

my .env.local file contains:

RETRIES="[1.0, 1.0]"

When I load the configuration I get:

TypeError: 'ellipsis' object is not callable

If i use a type tuple[float, float], this works fine.
If I don't add the variable in my env file, the default works fine.
Using parenthesis on the env variable instead of brackets did not work.
Also using typing.Tuple did not help.

Not sure what to do here, only workaround is a List.

Python version 3.9, envclasses 0.2.8.

Thanks for your good work.

Support python 3.9

Add python3.9 in CI script, and add python3.9 classifier in setup.py

Implement setenv?

module is installed, but missing library stubs or py.typed marker

Support Decimal

@envclass
@dataclass
class Hoge:
        d: Decimal

h = Hoge(d=Decimal(10))
os.environ['ENV_D'] = '20'

assert isinstance(h.d, Decimal)
assert h.d == Decimal(20)

Couldn't import envclasses 0.2.5

$ python
Python 3.9.6 (default, Jun 28 2021, 19:24:41)
[Clang 12.0.5 (clang-1205.0.22.9)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import envclasses
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'envclasses'

Publish with Github Actions

It would be nice if we could automate publishing the package with Github Actions