Skip to main content

Wrapper that combines argparse with yaml config files.

Project description

Travis

A wrapper for combining yaml configuration files and command line argument parsing. It builds upon PyYAML for parsing yaml config files and argparse for handling command line arguments and adds the clue produce one unified program configuration.

Requirements

  • Python 2.7+ or 3.2+
  • PyYAML >= 3.1

Configuration Environments

Because configuration often differs depending on the environment, e.g. production and testing settings, yconf allows you to define multiple environments in a single configuration. The current supported environemts are production, staging and development. For convenience, yconf is able to merge environment configuration to reduce redundancy, meaning that if the environment is set to staging, the configuration will inherit all settings available in a production environment and override them with staging values where neseccary.

Example

config.yml

production:
  rundir: /var/run/example
  database: /var/lib/example/db.sqlite
  loglevel: warning

staging:
  database: :memory:

development:
  loglevel: debug

Configuration

# production environment
config.rundir: /var/run/example
config.database: /var/lib/example/db.sqlite
config.loglevel: warning

# staging environment
config.rundir: /var/run/example
config.database: :memory:
config.loglevel: warning

# development environment
config.rundir: /var/run/example
config.database: :memory:
config.loglevel: debug

Both staging and development environments are optional.

If a directory is specified instead of a configuration file, yconf will look for configuration files by convention of <environment>.yml in that directory and merge them accordingly if possible.

Command Line Arguments

Extending the argument list supported by a configuration will require subclassing yconf.BaseConfiguration and overriding the makeParser method.

Example

import sys
from yconf import BaseConfiguration

class MyConfig(BaseConfiguration):

  def makeParser(self):
    parser = super(MyConfig, self).makeParser()
    parser.add_argument("-f", "--foo", dest="foo")
    return parser


config = MyConfig()
config.parse(sys.argv[1:])

The following configuration arguments are already preset:

  • -c Path to configuration file or directory
  • -e The environment used for configuration (default: production)

When present, command line argument always take precedent over configuration settings. To override nested yaml values, a dotted destination path can be set for the argument.

config.yml

logging:
  loglevel: debug

Argument

parser.add_argument("--log-level", dest="logging.loglevel")

Accessing Configuration

Configuration can be accessed either by attribute or by key.

config = MyConfig()
config.parse(args)

config.foo == config['foo']
config.foo.bar == config['foo']['bar']

Project details


Release history Release notifications

This version
History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

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
yconf-0.3.4.tar.gz (7.9 kB) Copy SHA256 hash SHA256 Source None Apr 23, 2017

Supported by

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