Mercurial > hgrepos > Python > libs > ConfigMix

annotate README.txt @ 92:75738d488e9d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; mode: rst; -*-
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
3 .. _README:
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
4
69
b511c6d5dec2 Use "Repository" instead of "Path" and use "$Header$" instead of "$HGheader"
Franz Glasner <hg@dom66.de>
parents: 62
diff changeset
5 :Author: Franz Glasner
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
6 :Version: |release|
77
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 71
diff changeset
7 :Date: |today|
78
3a8f712d27df Put copyright and license into the README.txt
Franz Glasner <hg@dom66.de>
parents: 77
diff changeset
8 :Copyright: (c) 2015–2018, Franz Glasner.
3a8f712d27df Put copyright and license into the README.txt
Franz Glasner <hg@dom66.de>
parents: 77
diff changeset
9 All rights reserved.
3a8f712d27df Put copyright and license into the README.txt
Franz Glasner <hg@dom66.de>
parents: 77
diff changeset
10 :License: 3-clause BSD License.
3a8f712d27df Put copyright and license into the README.txt
Franz Glasner <hg@dom66.de>
parents: 77
diff changeset
11 See :ref:`LICENSE.txt <license>` for more details.
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
12 :Revision: |VCSRevision|
69
b511c6d5dec2 Use "Repository" instead of "Path" and use "$Header$" instead of "$HGheader"
Franz Glasner <hg@dom66.de>
parents: 62
diff changeset
13 :Repository: |VCSHGpath|
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
14
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
15
5
dc058099a4cb Renamed the project from "MixConfig" to "ConfigMix"
Franz Glasner <hg@dom66.de>
parents: 0
diff changeset
16 "ConfigMix" is a library for helping with configuration files.
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
17
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
18 It reads configuration files in the following styles:
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
19
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
20 - YAML files
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
21 - INI files
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
22 - executable Python files
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
23
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
24 It then merges them together into a tree-ish configuration dictionary and
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
25 presents them as such to the API user. Reading can be done with
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
26 keyword expansion from other configuration values.
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
27
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
28
87
3b02c08e51df Change section header
Franz Glasner <hg@dom66.de>
parents: 81
diff changeset
29 Further References and Inspirations
3b02c08e51df Change section header
Franz Glasner <hg@dom66.de>
parents: 81
diff changeset
30 -----------------------------------
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
31
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
32 Search for "yaml" on `PyPi`
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
33
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
34 - https://pypi.python.org/pypi/layered-yaml-attrdict-config/16.1.0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
35
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
36 The package and it's "Links" section
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
37
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
38
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
39 - https://configloader.readthedocs.org/en/latest/
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
40
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
41 For the API