Metadata-Version: 2.1
Name: treeconfigparser
Version: 1.0.2
Summary: Custom configuration parser based on a tree
Home-page: https://github.com/cerea-daml/treeconfigparser
Author: Alban Farchi
Author-email: alban.farchi@enpc.fr
License: UNKNOWN
Project-URL: Documentation, https://cerea-daml.github.io/treeconfigparser/
Project-URL: Source, https://github.com/cerea-daml/treeconfigparser
Project-URL: Bug Tracker, https://github.com/cerea-daml/treeconfigparser/issues
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: path
Requires-Dist: numpy


treeconfigparser
================

[![PyPI](https://img.shields.io/pypi/v/treeconfigparser)](https://pypi.org/project/treeconfigparser)
[![Anaconda-Server Badge](https://anaconda.org/alfarchi/treeconfigparser/badges/version.svg)](https://anaconda.org/alfarchi/treeconfigparser)

Custom configuration parser based on a tree. 

[Documentation]

[Documentation]: https://cerea-daml.github.io/treeconfigparser

Installation
------------

Install using pip:

    $ pip install treeconfigparser

or using conda:

    $ conda install -c alfarchi treeconfigparser

Main usage
----------

    >>> import treeconfigparser as tcp
    >>> config = tcp.TreeConfigParser()
    >>> config.read_file(file_name)
    >>> config.get(['sec1', 'subsec11', 'opt1'])
    'val1'

Features
--------

- Arbitrary configuration tree are possible.
- Can read and parse configuration file. Two different
  and intuitive file formats are supported.
- Configuration files can include comments and
  cross-references between options.
- Alternatively, the configuration can be manipulated
  using the class methods.
- The access to options is simple and supports customised 
  type conversions.
- The configuration can also be written to a file to be
  re-used later on.

More details can be found in the [documentation].



