Mercurial > hgrepos > Python > libs > ConfigMix

annotate README.txt @ 549:84657447ab39

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
FIX: Properly raise a UnicodeEncodeError from C
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 02 Jan 2022 01:00:10 +0100
parents 16f077229ec2
children f454889e41fa
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
535
16f077229ec2 +++++ v0.20
Franz Glasner <fzglas.hg@dom66.de>
parents: 472
diff changeset
6 :Version: 0.20
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|
290
aec97edf7945 Prepare for new dev: bump version to 0.13.dev1 and adjust copyright year for most important files
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 286
diff changeset
8 :Copyright: (c) 2015–2021, 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.
296
eed16a1ec8f3 Use SPDX license identifiers (either full or short) all over the package
Franz Glasner <fzglas.hg@dom66.de>
parents: 290
diff changeset
10 :License: BSD 3-Clause "New" or "Revised" License.
78
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.
200
c6904d02beae Doc: some wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 195
diff changeset
12 :Revision: |VCSHGrevision|
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
200
c6904d02beae Doc: some wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 195
diff changeset
16 "ConfigMix" is a library to help with the configuration of
143
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
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 170
diff changeset
25 - TOML files
94
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 92
diff changeset
26 - 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
27
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
28 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
29 tree-ish configuration dictionary and presents them as such to the
202
2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead
Franz Glasner <fzglas.hg@dom66.de>
parents: 200
diff changeset
30 application. Reading can be done with variable interpolation from
2e66178a09d8 Docu: Ban "keyword expansion" -- use "variable interpolation" instead
Franz Glasner <fzglas.hg@dom66.de>
parents: 200
diff changeset
31 other 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
32
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
33
143
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
34 References and Inspirations
252645c69c7b Better wording in then README
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
35 ---------------------------
0
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
36
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
37 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
38
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
39 - 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
40
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
41 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
42
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
43 - 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
44
53ea2bc254e7 Begin a package to abstract some of the important configuration handling stuff.
Franz Glasner <hg@dom66.de>
parents:
diff changeset
45 For the API