Welcome to constantdict's documentation
=======================================

This site covers constantdict's API documentation. For more information about constantdict, see `the Github repository <https://github.com/matthiasdiener/constantdict>`_.

Usage
-----

The :class:`.constantdict` class can be used as a replacement for :class:`dict`.
The API is the same as :class:`dict`, but without methods that mutate the
dictionary.

.. literalinclude:: ../examples/demo.py
   :language: python

Some additional methods compared to :class:`dict` are provided, see the API
reference below.


API reference
-------------

.. toctree::
   :maxdepth: 1

   constantdict
   comparison

   🚀 Github <https://github.com/matthiasdiener/constantdict>
   💾 Download Releases <https://pypi.org/project/constantdict>