comparison README.txt @ 92:75738d488e9d

Extended the README.txt about the high-level workings of the package
author Franz Glasner <hg@dom66.de>
date Sun, 18 Mar 2018 14:21:48 +0100
parents 3b02c08e51df
children 2b79ddc0f92b
comparison
equal deleted inserted replaced
91:5ca36fbea43d 92:75738d488e9d
1 .. -*- coding: utf-8; mode: rst; -*- 1 .. -*- coding: utf-8; mode: rst; -*-
2 2
3 .. _README: 3 .. _README:
4 4
5 :Author: Franz Glasner 5 :Author: Franz Glasner
6 :Version: |release| 6 :Version: |release|
7 :Date: |today| 7 :Date: |today|
8 :Copyright: (c) 2015–2018, Franz Glasner. 8 :Copyright: (c) 2015–2018, Franz Glasner.
9 All rights reserved. 9 All rights reserved.
10 :License: 3-clause BSD License. 10 :License: 3-clause BSD License.
11 See :ref:`LICENSE.txt <license>` for more details. 11 See :ref:`LICENSE.txt <license>` for more details.
12 :Revision: |VCSRevision| 12 :Revision: |VCSRevision|
13 :Repository: |VCSHGpath| 13 :Repository: |VCSHGpath|
14 14
15 15
16 "ConfigMix" is a library for helping with configuration files. 16 "ConfigMix" is a library for helping with configuration files.
17
18 It reads configuration files in the following styles:
19
20 - YAML files
21 - INI files
22 - executable Python files
23
24 It then merges them together into a tree-ish configuration dictionary and
25 presents them as such to the API user. Reading can be done with
26 keyword expansion from other configuration values.
17 27
18 28
19 Further References and Inspirations 29 Further References and Inspirations
20 ----------------------------------- 30 -----------------------------------
21 31