nihonjinrxs / flask-dotenv Goto Github PK

Flask-DotEnv will directly set (add, update and map as alias) variable from .env file, and cast to Python native types as appropriate.

$ pip install Flask-DotEnv

from flask import Flask
from flask.ext.dotenv import DotEnv

app = Flask(__name__)
env = DotEnv(app)

As factory pattern.

env = DotEnv()
env.init_app(app)

class Config:
    SECRET_KEY = ":'("
    ...

    @classmethod
    def init_app(self, app)
        env = DotEnv()
        env.init_app(app)

Then in your app:

from config import config

app = Flask(__name__)
app.config.from_object(config[config_name])

See also:

flask.Config.from_object (API — Flask Documentation)

You can pass .env file path as second argument of init_app().

env.init_app(app, env_file="/path/to/.env", verbose_mode=True)

* Overwriting an existing config var: SECRET_KEY
* Setting an entirely new config var: DEVELOPMENT_DATABASE_URL
* Mapping a specified var as a alias: DEVELOPMENT_DATABASE_URL => SQLALCHEMY_DATABASE_URI
...

alias() method takes a dict argment.

env.alias(maps={
  'TEST_DATABASE_URL': 'SQLALCHEMY_DATABASE_URI',
  'TEST_HOST': 'HOST'
})

This is example usage of alias:

class Config:
    SECRET_KEY = ":'("
    ...

    @classmethod
    def init_app(self, app)
        env = DotEnv()
        env.init_app(app)

        # this will set var like a `DEVELOPMENT_DATABASE_URL` as `SQLALCHEMY_DATABASE_URI`
        prefix = self.__name__.replace('Config', '').upper()
        env.alias(maps={
            prefix + '_DATABASE_URL': 'SQLALCHEMY_DATABASE_URI'
        })


class DevelopmentConfig(Config):
    DEBUG = True
    SQLALCHEMY_DATABASE_URI = None


config = {
    'development': DevelopmentConfig
}

Run unittest.

$ python setup.py test

Inspired from:

• python-dotenv
• django-dotenv

See another packages, its also set config vars:

• Flask-EnvConfig
• Flask-UserEnvConfig

BSD 2-Clause License