Python Other
Clone or download
jab Merge pull request #76 from jab/dev
silence latest spurious lgtm warnings
Latest commit b46b7a6 Jul 16, 2018
Permalink
Failed to load latest commit information.
assets tweak docs, setup.py, travis, and hypothesis tests Apr 19, 2018
bidict silence latest spurious lgtm warnings Jul 17, 2018
docs Fix updating orderedbidict.inv Apr 28, 2018
tests update to latest pylint (2.0.0) and appease it Jul 17, 2018
.LICENSE_HEADER update pre-commit hooks, enable pylint Apr 7, 2018
.coveragerc switch to codecov for automatic combining of coverage reports Nov 20, 2017
.editorconfig refactor, tests + docs improvements Apr 27, 2015
.gitignore bidict.pairs -> _iteritems_args_kw, docs + other small improvements Apr 6, 2018
.lgtm.yml optimize implementations of keys, values, and items Apr 25, 2018
.pre-commit-config.yaml update pre-commit hooks, enable pylint Apr 7, 2018
.pylintrc update to latest pylint (2.0.0) and appease it Jul 17, 2018
.readthedocs.yml strengthen too-weak assume(..) in test_eq_ne_hash, use "max_examples=… Apr 10, 2018
.travis.yml test python 3.7 on travis Jul 17, 2018
CHANGELOG.rst Use less memory in OrderedBidict, v0.17.2 Apr 30, 2018
CODE_OF_CONDUCT.rst bidict.pairs -> _iteritems_args_kw, docs + other small improvements Apr 6, 2018
CONTRIBUTING.rst tweak docs, setup.py, travis, and hypothesis tests Apr 19, 2018
LICENSE change license to MPLv2 Mar 15, 2017
MANIFEST.in alphabetize MANIFEST.in Jan 16, 2018
PYPI_DOWNLOAD_STATS.rst bidict.pairs -> _iteritems_args_kw, docs + other small improvements Apr 6, 2018
README.rst tweak docs, setup.py, travis, and hypothesis tests Apr 19, 2018
appveyor.yml test python 2.7 on appveyor instead of 3.5 Feb 19, 2018
build-docs.sh bidict.pairs -> _iteritems_args_kw, docs + other small improvements Apr 6, 2018
pytest.ini bidict.pairs -> _iteritems_args_kw, docs + other small improvements Apr 6, 2018
setup.cfg update to latest pylint (2.0.0) and appease it Jul 17, 2018
setup.py update to latest pylint (2.0.0) and appease it Jul 17, 2018
tox.ini various code and CI improvements + dependency updates (#42) Nov 16, 2017

README.rst

bidict

Efficient, Pythonic bidirectional map implementation and related functionality.

bidict logo

Status

Latest release Documentation Travis-CI build status AppVeyor (Windows) build status Test coverage Codacy grade License

Bidict:

  • is in use by several teams at Google, Venmo, CERN, Bank of America Merrill Lynch, Two Sigma, and many others,
  • has carefully designed APIs for safety, simplicity, flexibility, and ergonomics,
  • is CPython-, PyPy-, Python 2-, and Python 3-compatible,
  • has extensive test coverage, including property-based tests and benchmarks, which are run continuously on all supported Python versions and OSes,
  • integrates with Python’s collections interfaces and abstract base classes,
  • has mature, well-factored, well-documented code.

Installation

pip install bidict

Quick Start

>>> from bidict import bidict
>>> element_by_symbol = bidict({'H': 'hydrogen'})
>>> element_by_symbol['H']
'hydrogen'
>>> element_by_symbol.inv['hydrogen']
'H'

For more usage documentation, head to the intro [1] and proceed from there.

Community and Support

Chat

If you are thinking of using bidict in your work, or if you have any questions, comments, or suggestions, I'd love to know about your use case and provide as much support for it as possible.

Please feel free to leave a message in the chatroom or to open a new issue on GitHub. You can search through existing issues before creating a new one in case your questions or concerns have been adressed there already.

Notice of Usage

If you use bidict, and especially if your usage or your organization is significant in some way, please let me know.

You can:

Changelog

See the changelog [2] for a history of notable changes to bidict.

Release Notifications

Follow on libraries.io

Tip: Subscribe to bidict releases on libraries.io to be notified when new versions of bidict are released.

Learning from bidict

One of the most rewarding things about bidict is the outsized amount of advanced Python it covers in light of its small codebase.

Check out learning-from-bidict [3] if you're interested in learning more.

Contributing

Bidict is currently a one-person operation maintained on a voluntary basis with no other sponsorship. Your help would be most welcome!

Reviewers Wanted!

One of the most valuable ways to contribute to bidict and to explore some advanced Python <learning-from-bidict> while you're at it is to review bidict's relatively small codebase.

Please create an issue or pull request with any improvements you'd propose or any other results you found. (Submitting a "Nothing-to-merge" PR with feedback in inline code comments or a Review results issue both work well.)

You can also +1 this issue to sign up to give feedback on future proposed changes that are in need of a reviewer.

Funding

If bidict has helped you accomplish your work, especially work you've been paid for, please consider chipping in toward the costs of bidict's maintenance and development and/or ask your organization to do the same. Any amount contributed is gratefully received.

Support bidict

Finding Documentation

If you're viewing this on https://bidict.readthedocs.io, note that multiple versions of the documentation are available, and you can choose a different version using the popup menu at the bottom-right. Please make sure you're viewing the version of the documentation that corresponds to the version of bidict you'd like to use.

If you're viewing this on GitHub, PyPI, or some other place that can't render and link this documentation properly and are seeing broken links, try these alternate links instead:

[1](1, 2) docs/intro.rst | https://bidict.readthedocs.io/intro.html
[2]CHANGELOG.rst | https://bidict.readthedocs.io/changelog.html
[3]docs/learning-from-bidict.rst | https://bidict.readthedocs.io/learning-from-bidict.html

Next: intro [1]