Easily set Flask settings from environment variables
Project description
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_'
)- ENV_LOAD_ALL
Whether or not to load all environment variables for the configuration object. When
False
only settings predefined on the configuration object are loaded, all others are ignored. WhenTrue
all environment variables defined inos.environ
will get loaded into your configuration object. (defaultFalse
)
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_'
ENV_LOAD_ALL = False
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
Built Distribution
File details
Details for the file Flask-Env-2.0.0.tar.gz
.
File metadata
- Download URL: Flask-Env-2.0.0.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e10ebc8ac8f5d4696f228be8ad528c697c701b706c754fc54c8a5aa784eb73f1 |
|
MD5 | 18bed0d3b3e127ee83800c6bddfbe05f |
|
BLAKE2b-256 | 92c42146ffb5dbbee8718e35dbcda74b416a6a986bf06e4f408a2ce751b6b248 |
File details
Details for the file Flask_Env-2.0.0-py3-none-any.whl
.
File metadata
- Download URL: Flask_Env-2.0.0-py3-none-any.whl
- Upload date:
- Size: 3.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6515b2cb2f62dc2743ba2600f4583147128f28a36cb73040a2ab12c54e329f67 |
|
MD5 | ccb909f2733d91692beb924d391a1506 |
|
BLAKE2b-256 | b20b64d974a7ae63d73401c3cb3288b5ede82493af03aae0d4b0a4dc40051e19 |