Skip to main content

Painless YAML configuration.

Project description

https://github.com/beetbox/confuse/workflows/Build/badge.svg?branch=master http://img.shields.io/pypi/v/confuse.svg

Confuse is a configuration library for Python that uses YAML. It takes care of defaults, overrides, type checking, command-line integration, human-readable errors, and standard OS-specific locations.

What It Does

Here’s what Confuse brings to the table:

  • An utterly sensible API resembling dictionary-and-list structures but providing transparent validation without lots of boilerplate code. Type config['num_goats'].get(int) to get the configured number of goats and ensure that it’s an integer.

  • Combine configuration data from multiple sources. Using layering, Confuse allows user-specific configuration to seamlessly override system-wide configuration, which in turn overrides built-in defaults. An in-package config_default.yaml can be used to provide bottom-layer defaults using the same syntax that users will see. A runtime overlay allows the program to programmatically override and add configuration values.

  • Look for configuration files in platform-specific paths. Like $XDG_CONFIG_HOME or ~/.config on Unix; “Application Support” on macOS; %APPDATA% on Windows. Your program gets its own directory, which you can use to store additional data. You can transparently create this directory on demand if, for example, you need to initialize the configuration file on first run. And an environment variable can be used to override the directory’s location.

  • Integration with command-line arguments via argparse or optparse from the standard library. Use argparse’s declarative API to allow command-line options to override configured defaults.

Installation

Confuse is available on PyPI and can be installed using pip:

pip install confuse

Using Confuse

Confuse’s documentation describes its API in detail.

Credits

Confuse was made to power beets. Like beets, it is available under the MIT license.

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

confuse-1.6.0.tar.gz (45.8 kB view details)

Uploaded Source

Built Distribution

confuse-1.6.0-py2.py3-none-any.whl (23.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file confuse-1.6.0.tar.gz.

File metadata

  • Download URL: confuse-1.6.0.tar.gz
  • Upload date:
  • Size: 45.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for confuse-1.6.0.tar.gz
Algorithm Hash digest
SHA256 d60104c0b2a708041ac27487fa6ee69bd37d910549659c7ba92f52cbe2ced4dc
MD5 50cefa39528810f8c201f921d10d4e1c
BLAKE2b-256 dbecfd93d96a32f54a3e19124179e86cced96da590d946c739a599f26d775a5f

See more details on using hashes here.

File details

Details for the file confuse-1.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: confuse-1.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for confuse-1.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82137fae8aab189901f16ed9155268e34ec8673f13db0ad331ab670528ceb999
MD5 1cbdb3cd3985867e87fe4061ecff92f8
BLAKE2b-256 a1bf3808a60fc15fd403093cc2a8c684064cc8a39d874228e39a6272a65dcb62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page