========
FlatDict
========

|PyPI Version| |Last Release| |Monthly Downloads| |License| |Issues|

FlatDict is a Python library for interacting with nested dictionaries and
lists as a single-level dictionary with delimited keys.

This library provides the :py:class:`~cj365.flatdict.FlatDict` class for
flattening nested dictionaries, and the :py:class:`~cj365.flatdict.FlatterDict`
class for flattening nested dictionaries and sequences (lists and tuples).


.. |PyPI Version| image:: https://img.shields.io/pypi/v/cj365-flatdict?label=PyPI&logo=pypi
   :target: https://pypi.org/project/cj365-flatdict/
   :alt: pypi

.. |Last Release| image:: https://img.shields.io/github/release-date/codejedi365/flatdict?display_date=published_at
   :target: https://github.com/codejedi365/flatdict/releases/latest
   :alt: GitHub Release Date

.. |Monthly Downloads| image:: https://img.shields.io/pypi/dm/cj365-flatdict
   :target: https://pypistats.org/packages/cj365-flatdict
   :alt: PyPI - Downloads

.. |License| image:: https://img.shields.io/pypi/l/cj365-flatdict?color=blue
   :target: https://github.com/codejedi365/flatdict/blob/main/LICENSE
   :alt: PyPI - License

.. |Issues| image:: https://img.shields.io/github/issues/codejedi365/flatdict
   :target: https://github.com/codejedi365/flatdict/issues
   :alt: GitHub Issues


Documentation Contents
======================

.. toctree::
   :maxdepth: 1

   What's New <misc/changelog>
   Concepts <concepts/index>
   API <api/index>
   FAQ <misc/faq>
   Contributing <contributing/index>
   View on GitHub <https://github.com/codejedi365/flatdict>
..    upgrading/index

----

.. include:: concepts/installation.rst
   :start-after: .. _installation:

----

.. _quick_reference:
.. include:: concepts/quick_reference.rst