Skip to main content

A helping hand to manage your settings among different environments

Project description

A helping hand to manage your settings among different environments

## Intro

Managing application configuration that runs on multiple environments
can be tough. So **milieu** comes to help you pretend you have only
one settings file that magically works whenever you deploy.

## Production

The system environment is the first place **milieu** will try to find
things. So, when the application runs inside of an environment with the right
variables set, it will just work.

So, if you know you have the environment variable `DATABASE_URI` like this:

```bash
$ export DATABASE_URI=mysql://root@localhost:3306/mydb
```

The application settings glue code will look like this:

```python
>>> from milieu import Environment
>>> env = Environment()
>>> dburi = env.get_uri('DATABASE_URI')
>>> dburi.host
u'localhost'
>>> dburi.port
3306
```

## Local

If you just want to load things from a file locally, the
`Environment.from_file()` constructor will help you out.

```python
>>> from milieu import Environment
>>> env = Environment.from_file('/etc/app.cfg')
>>> env.get_bool('BOOL_FLAG')
True
>>> env.get_float('FLOAT_VAL')
3.14
```

The file `app.cfg` will look like this:

```yaml
BOOL_FLAG: True

FLOAT_VAL: 3.14
```

## From a folder

You can also load variables from a folder, where each file will be an
environment variable and the file's content will be the value. Just
like [envdir](http://cr.yp.to/daemontools/envdir.html).

Now, say that you have the folder `/etc/envdir/app` and this folder
contains the file `MYSQL_CONN_URI` with a database URL inside of
it. Just like this one here:
`mysql://root:secret@localhost:3306/mydb`.

To read that directory and load the variable properly, you just have
to do the following:

```python
>>> from milieu import Environment
>>> env = Environment.from_folder('/etc/envdir/app')
>>> uri = env.get_uri('MYSQL_CONN_URI')
>>> uri.host
'localhost'
>>> uri.port
3306
>>> uri.user
'root'
>>> uri.password
'secret'
```

# Hacking on it

## Install dev dependencies

```console
pip install -r requirements-dev.txt
```

## Run tests

```console
make test
```

## Change it

Make sure you write tests for your new features and keep the test
coverage in 100%

## Release it

After you already made your commits, run:

```console
make release
```

follow the instructions and do the
[harlem shake](http://www.youtube.com/watch?v=8vJiSSAMNWw)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
milieu-0.1.9.tar.gz (8.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page