Skip to main content

Library to simplify working with the environment

Project description

WConfig: Library to simplify working with the environment

PyPI version

Libraries used

Installation

pip install whaox-wconfig

Features

  • Modularity
  • Type conversion
  • Auto-return or handling

Setup

First, let's set up ours .env file

API_KEY=YOUR_API_KEY

API_URL=https://example.com

LOGGING=False

Usage

Not forget add this lines to your main.py file

from dotenv import load_dotenv

load_dotev()

Now let's create a config class

class Config:
    
    @VAR("API_KEY")
    def api_key(self): pass

You can easily get variables from your .env file

config = Config()
config.api_key()

>>> YOUR_API_KEY

Type conversion

You can cast the value to the desired type, to do this, specify the type in the _T parameter

NOTE: Supported types are str, bool, int, float

class Config:
    
    @VAR("LOGGING", bool)
    def logging(self) -> bool: pass

Handling

You can handle the received value if you need by setting the handle flag to True.

class Config:
    
    @VAR("API_KEY", handle=True)
    def api_key(self, var): 
        return 'prefix-' + var

Modularity

You can split your config class into modules

@Config("API")
class Api:
    
    @VAR("KEY")
    def key(self): pass
    
    @VAR("URL")
    def url(self): pass


class Config:
    api = Api()
    
    @VAR("LOGGING", bool)
    def logging(self): pass   
config = Config()

config.api.key()
config.logging()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whaox-wconfig-1.0.3.tar.gz (5.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page