Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesstidard/sanic-envconfig
Pull environment variables into your sanic config.
https://github.com/jamesstidard/sanic-envconfig
configuration environment-variables extension sanic
Last synced: 2 months ago
JSON representation
Pull environment variables into your sanic config.
- Host: GitHub
- URL: https://github.com/jamesstidard/sanic-envconfig
- Owner: jamesstidard
- License: mit
- Created: 2017-03-01T04:17:19.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T10:57:50.000Z (about 2 years ago)
- Last Synced: 2024-10-13T11:59:49.516Z (3 months ago)
- Topics: configuration, environment-variables, extension, sanic
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 22
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-sanic - Sanic-EnvConfig
README
# sanic-envconfig
[](https://pypi.python.org/pypi/sanic-envconfig)
[](https://pypi.python.org/pypi/sanic-envconfig)
[](https://github.com/jamesstidard/sanic-envconfig/blob/master/LICENCE.txt)
[](https://travis-ci.org/jamesstidard/sanic-envconfig)
[](https://coveralls.io/github/jamesstidard/sanic-envconfig)
This extension helps you bring commandline & environment variables into your Sanic config.
The extension also leverages type hints to correctly cast those variables to the appropriate type. This can also be overridden and extended for your own types.
## How it Works
Define your config class and subclass `sanic_envconfig.EnvConfig`. To not pollute your config, only those variables defined (and in uppercase) in your config class will pulled from your environment or commandline variables.
The values set in your class will be the default values, overridden when there is a environment variable or commandline argument with the same name available. The priority order being: `commandline arguments > enviroment variables > config`.
Casting of the commandline & environment variables is decided by looking at the type hints declared on config class. If no hint has been declared, the type of the default value will be used. When a default value is also not provided the variable will be returned as whatever type it exists in `os.environ` or `sys.argv` (most certainly a `str`).
This extension takes care of correctly casting the common types `str`, `bool`, `int` and `float`. Though, `sanic_envconfig.EnvConfig` can be extended for custom types. Additionally, the supplied casting can be overridden if desired.
## Just Sanic?
The extension, for the moment, is generic enough where it could be used in another context. Though, future releases may more tightly couple it with Sanic.
## Installation
```bash
$ pip install sanic_envconfig
```
## Example Usage
```bash
DEBUG: false
DB_URL: postgresql://localhost:5433/environ
WORKERS: 4
$ python example.py --db-url "postgresql://localhost:5433/commandline"
```
```python
# example.py
from sanic import Sanic
from sanic_envconfig import EnvConfig
class Config(EnvConfig):
DEBUG: bool = True
DB_URL: str = None
WORKERS: int = 1
config = Config()
app = Sanic(__name__)
app.update_config(Config)
app.config.DEBUG # False
app.config.DB_URL # 'postgresql://localhost:5433/commandline'
app.config.WORKERS # 4
```
## Custom Casting
To override or extend the casting system, `sanic_envconfig.EnvConfig` provides a decorator. The decorator takes the type as a parameter and hands the decorated function any values of that type from the environment variables.
```bash
THEME: blue
```
```python
from enum import Enum
from sanic_envconfig import EnvConfig
class Color(Enum):
RED = 0
BLUE = 1
class Config(EnvConfig):
THEME: Color = None
@Config.parse(Color)
def parse_color(value):
return Color[value.upper()]
Config.THEME # Color.BLUE
```