The bidirectional mapping library for Python.
Go to file
jab fe7e7217cb refactor, tests + docs improvements
- break up single bidict.py module into multiple separate modules inside
  "bidict" package
  - new bidict.util and bidict.compat modules
  - move/rename bidict.fancy_iteritems to bidict.util.pairs
  - move bidict.iteritems and bidict.viewitems to bidict.compat
- condense docstrings by moving more documentation into separate sphinx pages
  in "docs" dir and doctests into separate files in new "tests" dir
- initial work on property-based testing using hypothesis
- adopt pytest
- bump to 0.9.0-dev
2015-04-27 11:08:27 -04:00
bidict refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
docs refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
tests refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
.editorconfig refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
.gitignore moving from hg to git, cutting 0.2.1 2014-09-23 10:08:21 -04:00
.pre-commit-config.yaml refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
.travis.yml refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
CONTRIBUTING.rst refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
LICENSE bump copyright to 2015 2015-03-22 13:40:59 -04:00
MANIFEST.in refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
README.rst refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
VERSION refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
bidict.py refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
setup.py refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
test.py refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00
tox.ini refactor, tests + docs improvements 2015-04-27 11:08:27 -04:00

README.rst

bidict
======
 
Bidirectional dict with convenient slice syntax: ``d[65] = 'A'`` ⇔ ``d[:'A'] == 65``

Status
------

.. image:: https://pypip.in/download/bidict/badge.svg
    :target: https://pypi.python.org/pypi/bidict
    :alt: Downloads per month

.. image:: https://pypip.in/version/bidict/badge.svg
    :target: https://pypi.python.org/pypi/bidict
    :alt: Latest release

.. image:: https://readthedocs.org/projects/bidict/badge/
    :target: https://bidict.readthedocs.org/
    :alt: Documentation

.. image:: https://pypip.in/status/bidict/badge.svg
    :target: https://pypi.python.org/pypi/bidict
    :alt: Development status

.. image:: https://travis-ci.org/jab/bidict.svg
    :target: https://travis-ci.org/jab/bidict
    :alt: Build status

.. image:: https://coveralls.io/repos/jab/bidict/badge.svg
    :target: https://coveralls.io/r/jab/bidict
    :alt: Test coverage

.. image:: https://www.codacy.com/project/badge/1c5bfb83d2d54d57898d4ede1c9157ee
    :target: https://www.codacy.com/app/jab/bidict
    :alt: Code quality

.. image:: https://pypip.in/py_versions/bidict/badge.svg
    :target: https://pypi.python.org/pypi/bidict
    :alt: Supported Python versions

.. image:: https://pypip.in/implementation/bidict/badge.svg
    :target: https://pypi.python.org/pypi/bidict
    :alt: Supported Python implementations

.. image:: https://pypip.in/license/bidict/badge.svg
    :target: https://raw.githubusercontent.com/jab/bidict/master/LICENSE
    :alt: License

.. image:: https://img.shields.io/badge/Paypal-Buy%20a%20Drink-blue.svg
    :target: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jab%40math%2ebrown%2eedu&lc=US&item_name=Buy%20a%20drink%20for%20jab&button_subtype=services&currency_code=USD&bn=PP%2dBuyNowBF%3aPaypal%2dBuy%2520a%2520Drink%2dblue%2esvg%3aNonHosted
    :alt: PayPal - Buy a drink

.. image:: https://api.bountysource.com/badge/team?team_id=72966&style=raised
    :target: https://www.bountysource.com/teams/jab
    :alt: Donate via Bountysource

.. image:: https://badges.gitter.im/Join%20Chat.svg
    :alt: Chat
    :target: https://gitter.im/jab/bidict

Installation
------------

``pip install bidict``

Usage
-----

See https://bidict.readthedocs.org.

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 /
tell us about your use case.

Check out
`CONTRIBUTING.rst <https://github.com/jab/bidict/blob/master/CONTRIBUTING.rst>`_
for information about contributing.