The bidirectional mapping library for Python.
Project description
The bidirectional mapping library for Python.
Status
bidict:
has been used for many years by several teams at Google, Venmo, CERN, Bank of America Merrill Lynch, Bloomberg, Two Sigma, and many others
has carefully designed APIs for safety, simplicity, flexibility, and ergonomics
is fast, lightweight, and has no runtime dependencies other than Python’s standard library
integrates natively with Python’s collections.abc interfaces
provides type hints for all public APIs
is implemented in concise, well-factored, pure (PyPy-compatible) Python code that is optimized for running efficiently as well as for reading and learning [1]
has extensive docs and test coverage (including property-based tests and benchmarks) run continuously on all supported Python versions
Installation
pip install bidict
Quick Start
>>> from bidict import bidict
>>> element_by_symbol = bidict({'H': 'hydrogen'})
>>> element_by_symbol['H']
'hydrogen'
>>> element_by_symbol.inverse['hydrogen']
'H'For more usage documentation, head to the intro [3] and proceed from there.
Voluntary Community Support
Please feel free to leave a message in the bidict chatroom or open a new issue on GitHub for voluntary community support. You can search through existing issues before creating a new one in case your issue has been addressed already.
Enterprise Support
Enterprise-level support for bidict can be obtained via the Tidelift subscription.
Notice of Usage
If you use bidict, and especially if your usage or your organization is significant in some way, please let me know in any of the following ways:
leave a message in the chat room
Changelog
See the changelog [2] for a history of notable changes to bidict.
Release Notifications
Watch releases on GitHub or libraries.io to be notified when new versions of bidict are released.
Learning from bidict
One of the best things about bidict is that it touches a surprising number of interesting Python corners, especially given its small size and scope.
Check out learning-from-bidict [1] if you’re interested in learning more.
Contributing
bidict is currently a one-person operation maintained on a voluntary basis.
Your help would be most welcome! See the contributors-guide [4] for more information.
Sponsoring
Bidict is the product of thousands of hours of my unpaid work over the 12+ years I’ve been maintaining it.
If bidict has helped you accomplish your work, especially work you’ve been paid for, it’s easy to sponsor me through GitHub.
Choose a tier and GitHub handles everything else. The sponsorship just goes on your regular GitHub bill; there’s nothing extra to do. You can also sponsor me through Gumroad or PayPal.
Read more about companies supporting open source developers.
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:
Next: intro [3]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bidict-0.21.3.tar.gz.
File metadata
- Download URL: bidict-0.21.3.tar.gz
- Upload date:
- Size: 406.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d50bd81fae75e34198ffc94979a0eb0939ff9adb3ef32bcc93a913d8b3e3ed1d |
|
| MD5 | d9342771969dd0d42092a669ed6f3241 |
|
| BLAKE2b-256 | 3f817221b28d692af5c5fc180c4850b8e4a48c7db92b3d529b430488f67db74f |
File details
Details for the file bidict-0.21.3-py3-none-any.whl.
File metadata
- Download URL: bidict-0.21.3-py3-none-any.whl
- Upload date:
- Size: 36.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2cce0d01eb3db9b3fa85db501c00aaa3389ee4cab7ef82178604552dfa943a1b |
|
| MD5 | 850b15e6151c2ed00951d862c9383201 |
|
| BLAKE2b-256 | f2144b84e724b01f87625a645c30ff5b3f2e2877e86b792a1eb680b948e13a7b |
