bidict
======

Efficient, Pythonic bidirectional map implementation
and related functionality.

.. include:: status.rst.inc


Participation
-------------

Please feel free to `create an issue <https://github.com/jab/bidict/issues/new>`_
or `join the chat room <https://gitter.im/jab/bidict>`_
if you have any questions, feedback, or just want to say hi or
talk about your use case.

bidict is the result of hundreds of hours of voluntary, unpaid work.
If bidict has helped you accomplish work you've been paid for,
please `support bidict <https://gumroad.com/l/bidict>`_
and/or ask your organization to do the same.
Your support directly contributes to bidict's sustainability.

.. image:: https://raw.githubusercontent.com/jab/bidict/master/docs/_static/support-on-gumroad.png
    :target: https://gumroad.com/l/bidict
    :alt: Support bidict

:ref:`Click here <contributing>`
for more information about contributing.


Usage
-----

Let's get :ref:`started <intro>`.


.. toctree::
    :maxdepth: 2
    :hidden:

    intro.doctest
    basic-usage.doctest
    performance.doctest
    other-bidict-types.doctest
    inverted.doctest
    addendum
    changelog
    api
    contributing