Skip to main content

Automatic configuration file, command line, environment variable parser

Project description

https://travis-ci.org/gsemet/cfgtree.svg?branch=master Documentation Status https://coveralls.io/repos/github/gsemet/cfgtree/badge.svg Pypi package MIT licensed

Description

This package provides an easy yet comprehensive way of describing, storing, parsing, modifying user configuration for a modern application.

It requires the following acknolegdments:

  • Application settings are stored in a hierarchical structure, they can be organized into group of settings, subgroups, and they entierely depends on the application itself.

    This structure is called in cfgtree a “bare configuration”, or “configuration tree”, and is described by a “model”.

  • User settings may come from different inputs:

    • environment variables (“12-factors” approach). Example: MYAPP_VERBOSE.

    • command line argument. Example: --verbose

    • configuration storage such as file (json, yaml, ini) or configuration server. Example:

      {
          "verbose": true
      {

This allows you to define once your settings structure, and let the user of your application define the settings throught different ways. For instance, your application can read some settings through command line arguments, which is very useful for containerization of your application. It is indeed recommended by Heroku’s 12 Factor Good Practices.

Describing your configuration through a model also allows to have a configuration validator without having to maintain both a file schema (ex: JSON Schema) and the parsing logic code.

Access to settings

In your application, an xpath-like syntax allows you to reach any item of the configuration: cfg.get_cfg_value("key1.key2.key3.item").

To modify a key configuration, use cfg.set_cfg_value("key1.key2.key3.item", "new_value"). File is actually written on call of cfg.save_configuration() or automatically when autosave is set.

See the documentation for full explanation.

Similar opensource projects

Documentation

Full documentation is provided on ReadTheDocs.

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

cfgtree-1.1.1.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

cfgtree-1.1.1-py2.py3-none-any.whl (23.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cfgtree-1.1.1.tar.gz.

File metadata

  • Download URL: cfgtree-1.1.1.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cfgtree-1.1.1.tar.gz
Algorithm Hash digest
SHA256 83a2b1e9156716b1f4752abf314f63fd54ce7cebae0facff950f1fb08ff53ad0
MD5 0b39735ddd388b2a458a2c4bae888369
BLAKE2b-256 df0377463d611a4a690888db2d44855c3e0fb4eb3dcb6884932436fcef6e21f4

See more details on using hashes here.

Provenance

File details

Details for the file cfgtree-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cfgtree-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cf3ab88d9615bbc1645ef2864242eaffeb33a8e158a5b44424bafd009fd93469
MD5 fa8f812b4ad308dc46f706ca8a1785a6
BLAKE2b-256 79783b47b86e00abafeb3f1bfdb3809be4b3aaae3b688cfb691d960d30b30a8b

See more details on using hashes here.

Provenance

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