Metadata-Version: 2.0
Name: configupdater
Version: 0.1a2
Summary: Configuration parser like configparser but for updating config files
Home-page: https://configupdater.readthedocs.io/
Author: Florian Wilhelm
Author-email: florian.wilhelm@gmail.com
License: mit
Description-Content-Type: UNKNOWN
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers

.. image:: https://travis-ci.org/pyscaffold/configupdater.svg?branch=master
    :target: https://travis-ci.org/pyscaffold/configupdater
.. image:: https://coveralls.io/repos/pyscaffold/configupdater/badge.png
    :target: https://coveralls.io/r/pyscaffold/configupdater

=============
ConfigUpdater
=============

WORK IN PROGRESS!

The sole purpose of `ConfigUpdater`_ is to easily update an INI config file
with no changes to the original file except the intended ones. This means
comments, the ordering of sections and key/value-pairs as wells as their
case are kept as in the original file. Thus `ConfigUpdater`_ provides
complementary functionality to Python's `ConfigParser`_ which is primarily
meant for reading config files and writing new ones.

Differences
===========

The key differences to `ConfigParser`_ are:

* inline comments are treated as part of a key's value,
* empty lines in values are not valid,
* the original case of sections and keys are kept,
* control over the position of a new section/key

Following features are **deliberately not** implemented:

* interpolation of values,
* propagation of parameters from the default section,
* conversions of values,
* passing key/value-pairs with ``default`` argument,
* non-strict mode allowing duplicate sections and keys,


Note
====

`ConfigUpdater`_ is mainly developed for http://pyscaffold.org/.

.. _ConfigParser: https://docs.python.org/3/library/configparser.html
.. _ConfigUpdater: https://configupdater.readthedocs.io/


