loadcfg Documentation
=====================

Welcome to the **loadcfg** documentation!
-------------------------------------------

**loadcfg** is a lightweight Python library that makes it easy to load, validate, and generate configuration files in JSON and YAML formats—with intuitive dot-access to configuration values.

**Key Features:**

- **Easy Loading:** Quickly load configuration files (JSON or YAML) with a single function call.
- **Dot-Notation Access:** Access configuration values as attributes.
- **Template Validation:** Define configuration schemas using Python type annotations.
- **Example Generation:** Automatically generate example configurations in JSON or YAML.
- **Extensible:** Designed to be simple yet flexible for a variety of configuration tasks.

.. image:: https://img.shields.io/pypi/v/loadcfg
   :target: https://pypi.org/project/loadcfg
   :alt: PyPI Version

.. image:: https://img.shields.io/codecov/c/gh/danielkorkin/loadcfg
   :target: https://app.codecov.io/gh/danielkorkin/loadcfg/
   :alt: Codecov

.. image:: https://img.shields.io/readthedocs/loadcfg
   :target: https://loadcfg.readthedocs.io
   :alt: Read the Docs

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   usage
   modules

Indices and tables
====================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`