Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Environment configuration files parser
Python
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
envparser.egg-info
envparser
tests
.gitignore
.travis.yml
LICENSE
README.markdown
requirements
setup.cfg
setup.py

README.markdown

envparser

This is just a simple environment configurations parser. It aims to provide an easier way to parse configuration files organized in a certain way that makes it easy to use as a basis for different environments.

It's based on the ConfigParser module, but aims to be easier and simpler to use, although being less flexible.

Installing

If you use virtualenv:

$ pip install envparser

If you don't and your site-packages are shared for all users in your machine:

$ sudo pip install envparser

If you don't have any idea of what pip is (shame on you!), or can't use it:

$ easy_install envparser

or, after downloading (here) and unpacking the .tar.gz/.zip package:

$ python setup.py install

Development requirements

If you wish to contribute to the project as a developer, just install the requirements file included in the project with pip.

Examples

Using only one configuration file

# /home/myuser/myproject/mybaseconfiguration.cfg
[DEFAULT]
name: John Doe
age: 30
salary: 560.00
is_masculin: true
import envparser

parser = envparser.Parser('/home/myuser/myproject/mybaseconfiguration.cfg')
parser.get('name') # prints "John Doe"
parser.getint('age') # prints 30
parser.getfloat('salary') # prints 560.00
parser.getboolean('is_masculin') # prints True

Providing a different environment

# /home/myuser/myproject/mybaseconfiguration.cfg
[DEFAULT]
name: John Doe

[dev]
name: Awesome Developer
import envparser

parser = envparser.Parser('/home/myuser/myproject/mybaseconfiguration.cfg', 'dev')
parser.get('name') # prints "Awesome Developer"

Providing another file to overwrite the defaults

# /home/myuser/myproject/mybaseconfiguration.cfg
[DEFAULT]
name: John Doe
# /home/myuser/myproject/live.cfg
[DEFAULT]
name: John Doe Live
import envparser

parser = envparser.Parser('/home/myuser/myproject/mybaseconfiguration.cfg', 'live')
parser.get('name') # prints "John Doe Live"

Sections have higher priority than DEFAULT at environment files...

# /home/myuser/myproject/mybaseconfiguration.cfg
[DEFAULT]
name: John Doe

[live]
age: 20
# /home/myuser/myproject/live.cfg
[DEFAULT]
age: 30
import envparser

parser = envparser.Parser('/home/myuser/myproject/mybaseconfiguration.cfg', 'live')
parser.getint('age') # prints 20

...but if you specify the environment section in the environment file it will succeed in overwriting the base configuration

# /home/myuser/myproject/mybaseconfiguration.cfg
[DEFAULT]
name: John Doe

[live]
age: 20
# /home/myuser/myproject/live.cfg
[live]
age: 30
import envparser

parser = envparser.Parser('/home/myuser/myproject/mybaseconfiguration.cfg', 'live')
parser.getint('age') # prints 30

Important information

If you want to use a different environment and provide a file with the configurations to overwrite, you have to use the same file extension, or else the parser won't read it (your environment file will be ignored).

For example, if you provide "base.ini" as your base file, and "live.cfg" as the environment file, only "base.ini" will be read; But, if you use "base.ini" and "live.ini", then your environment file will be merged successfully.

Something went wrong with that request. Please try again.