Mercurial > hgrepos > Python > libs > ConfigMix

annotate README.txt @ 170:c247a5dc35ed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Begin development of a version 0.7 with some API changes
author Franz Glasner <f.glasner@feldmann-mg.com>
date Thu, 25 Apr 2019 16:14:50 +0200
parents d8155c429171
children 28e6c1413947
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
170
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
6 :Version: 0.7.dev1
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 156
diff changeset
7 :Date: |VCSJustDate|
156
e2e8d21b4122 Adjust copyright to year 2019
Franz Glasner <fzglas.hg@dom66.de>
parents: 143
diff changeset
8 :Copyright: (c) 2015–2019, Franz Glasner.
78
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
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
16 "ConfigMix" is a library for helping with the configuration of
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
17 applications and their configuration files.
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
18
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
19 It reads a couple of configuration files in the following different
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
20 styles:
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
21
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
22 - YAML files
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
23 - JSON files
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
24 - INI files
94
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 92
diff changeset
25 - executable Python scripts
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
26
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
27 It then merges the parsed contents of given files into a *unified*
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
28 tree-ish configuration dictionary and presents them as such to the
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
29 application. Reading can be done with keyword expansion from other
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
30 configuration values.
92
75738d488e9d Extended the README.txt about the high-level workings of the package
Franz Glasner <hg@dom66.de>
parents: 87
diff changeset
31
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
32
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
33 References and Inspirations
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
34 ---------------------------
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 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
37
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
38 - 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
39
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
40 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
41
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
42 - 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
43
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
44 For the API