Metadata-Version: 2.1
Name: py-envconfig
Version: 0.5.0
Summary: Managing environment config data
Home-page: UNKNOWN
Author: S. Williams-Wynn
Author-email: s.williamswynn.mail@gmail.com
License: UNKNOWN
Description: 
        <h1 align='center'>
            py-envconfig ⚙️
        </h1>
        
        <h4 align='center'>
            Managing config data from the environment, inspired by envconfig
        </h4>
        
        [envconfig](https://github.com/kelseyhightower/envconfig)
        
        ## Install
        
        ```
        pip install py-envconfig
        ```
        
        ## Usage
        
        Set some environment variable, or write a `.env` file.
        
        ```bash
        HOST=localhost
        PORT=6000
        
        MY_APP_SERVICE=bookings
        RELEASE_NUMBER=12
        ENV=dev
        ```
        
        Then specify your config:
        
        ```python
        from envconfig import param
        from envconfig import EnvConfig
        
        
        class AppConfig(EnvConfig):
            """App env config."""
        
            HOST = param.Str(required=True)
            PORT = param.Int(required=True)
            PASSWORD = param.Str(override="SECRET_REDIS_PW", required=True)
        
            SERVICE = param.Str(prefix="MY_APP_")
            VERSION = param.Int(override="RELEASE_NUMBER")
            ENV = param.Str(default="prod")
        
        
        config = AppConfig()
        
        # Access by class attribute or subscript
        config.USER
        config["USER"]
        ```
        
        Setup flask config:
        
        ```python
        config = AppConfig()
        app.config.from_object(config)
        ```
        
        Point to a `.env` file
        
        ```python
        config = AppConfig("./.env")
        ```
        
        ### Load Dotenv
        
        Some functionality provided by [dotenv](https://pypi.org/project/python-dotenv/)
        
        - Increase verbosity
        
            ```python
            AppConfig(verbose=True)
            ```
        
        - Override existing env vars with the env vars defined in `.env`.
        
            ```python
            AppConfig(override=True)
            ```
        
        ### Development
        
        To publish package and tag git:
        
        ```bash
        make tag
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
