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 details)

Uploaded Source

File details

Details for the file whaox-wconfig-1.0.3.tar.gz.

File metadata

  • Download URL: whaox-wconfig-1.0.3.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for whaox-wconfig-1.0.3.tar.gz
Algorithm Hash digest
SHA256 45649435b9c6dcf12af006d2311991efcaf871c969b517d5a2b6d39df9063a75
MD5 6f4a583bce0ee95ed726b41243a0c08c
BLAKE2b-256 fc0897c8545b0fd37d0af6a0d12b6e254a02faea74e3f3a5b70c41017cedd060

See more details on using hashes here.

Supported by

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