dicter's documentation!
========================

|python| |pypi| |docs| |stars| |LOC| |downloads_month| |downloads_total| |license| |forks| |open issues| |project status| |DOI| |repo-size| |donate|


.. |logo| image:: ../figs/logo.png

.. table::
   :align: center

   +----------+
   | |logo|   |
   +----------+

-----------------------------------



*dicter* is a Python package with advanced dictionary functions:

* Traverse through nested dicts to retrieve key-path.
* Set value in dictionary using key-path
* Get value in dictionary using key-path.
* Flattens dicts.
* Compare two dicts.
* Store and load in json.



-----------------------------------

.. note::
	**Your ❤️ is important to keep maintaining this package.** You can `support <https://erdogant.github.io/dicter/pages/html/Documentation.html>`_ in various ways, have a look at the `sponser page <https://erdogant.github.io/dicter/pages/html/Documentation.html>`_.
	Report bugs, issues and feature extensions at `github <https://github.com/erdogant/dicter/>`_ page.

	.. code-block:: console

	   pip install dicter

-----------------------------------

Content
=======


.. toctree::
   :maxdepth: 1
   :caption: Installation
   
   Installation


.. toctree::
  :maxdepth: 2
  :caption: Functions

  Functions


.. toctree::
  :maxdepth: 1
  :caption: Documentation
  
  Documentation
  Coding quality
  dicter.dicter


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`





.. |python| image:: https://img.shields.io/pypi/pyversions/dicter.svg
    :alt: |Python
    :target: https://erdogant.github.io/dicter/

.. |pypi| image:: https://img.shields.io/pypi/v/dicter.svg
    :alt: |Python Version
    :target: https://pypi.org/project/dicter/

.. |docs| image:: https://img.shields.io/badge/Sphinx-Docs-blue.svg
    :alt: Sphinx documentation
    :target: https://erdogant.github.io/dicter/

.. |stars| image:: https://img.shields.io/github/stars/erdogant/dicter
    :alt: Stars
    :target: https://img.shields.io/github/stars/erdogant/dicter

.. |LOC| image:: https://sloc.xyz/github/erdogant/dicter/?category=code
    :alt: lines of code
    :target: https://github.com/erdogant/dicter

.. |downloads_month| image:: https://static.pepy.tech/personalized-badge/dicter?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month
    :alt: Downloads per month
    :target: https://pepy.tech/project/dicter

.. |downloads_total| image:: https://static.pepy.tech/personalized-badge/dicter?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads
    :alt: Downloads in total
    :target: https://pepy.tech/project/dicter

.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :alt: License
    :target: https://github.com/erdogant/dicter/blob/master/LICENSE

.. |forks| image:: https://img.shields.io/github/forks/erdogant/dicter.svg
    :alt: Github Forks
    :target: https://github.com/erdogant/dicter/network

.. |open issues| image:: https://img.shields.io/github/issues/erdogant/dicter.svg
    :alt: Open Issues
    :target: https://github.com/erdogant/dicter/issues

.. |project status| image:: http://www.repostatus.org/badges/latest/active.svg
    :alt: Project Status
    :target: http://www.repostatus.org/#active

.. |donate| image:: https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors
    :alt: donate
    :target: https://erdogant.github.io/dicter/pages/html/Documentation.html#

.. |DOI| image:: https://zenodo.org/badge/584101058.svg
    :alt: Cite
    :target: https://zenodo.org/badge/latestdoi/584101058

.. |repo-size| image:: https://img.shields.io/github/repo-size/erdogant/dicter
    :alt: repo-size
    :target: https://img.shields.io/github/repo-size/erdogant/dicter




.. include:: add_bottom.add