Skip to main content

Easily set Flask settings from environment variables

Project description

https://badge.fury.io/py/flask-env.svg https://travis-ci.org/brettlangdon/flask-env.svg?branch=master

Easily set Flask settings from environment variables.

The reason for using flask-env is to be able to follow the 12-factor app suggestions for configuring your application.

With flask-env you can define your default configuration options in code and very easily override via environment variables.

Installation

pip install Flask-Env

Usage

With flask-env you will define your configuration as an object and load it into your Flask application via app.config.from_object method.

Python 2

from flask import Flask
from flask_env import MetaFlaskEnv


class Configuration(object):
    __metaclass__ = MetaFlaskEnv

    DEBUG = False
    PORT = 5000


app = Flask(__name__)
app.config.from_object(Configuration)

Python 3

from flask import Flask
from flask_env import MetaFlaskEnv


class Configuration(metaclass=MetaFlaskEnv):
    DEBUG = False
    PORT = 5000


app = Flask(__name__)
app.config.from_object(Configuration)

Overriding environment variables

# Export environment variable for shell session
export DEBUG=true

# Set explicitly for a specific command execution
PORT=8000 python app.py

Configuring flask-env

flask-env offers two configuration options to determine how/which environment variables are loaded.

ENV_PREFIX

Only consider environment variables that start with this prefix. The prefix will be removed from the environment variable name when setting in the configuration. (default: '', example: ENV_PREFIX = 'MYAPP_')

Setting configuration values

You can set the flask-env configuration settings directly on your Flask configuration object.

from flask_env import MetaFlaskEnv


class Configuration(metaclass=MetaFlaskEnv):
    ENV_PREFIX = 'MYAPP_'

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

Flask-Env-1.0.1.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file Flask-Env-1.0.1.tar.gz.

File metadata

  • Download URL: Flask-Env-1.0.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask-Env-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5356d8ae1f3825c9f12a09015047b60ef062687c5b3c3222d3ef1a3c93d05d34
MD5 665088a8f54035ac82d1f41bed1eebe4
BLAKE2b-256 b54a584b4556b9290b8b1341342706855eeb419b366b12a5bbdb55667f0e62e0

See more details on using hashes here.

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