Efficient, Pythonic bidirectional map implementation and related functionality
Project description
Efficient, Pythonic bidirectional map implementation and related functionality.
Status
Bidict:
is in use by several teams at Google, Venmo, 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
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:
quickly +1 this issue
create your own dedicated issue
leave a message in the chat room
Changelog
See the changelog [2] for a history of notable changes to bidict.
Release Notifications
Tip: Follow bidict on Sibbell to be notified when a new version of bidict is released.
Learning from bidict
One of the most rewarding things about working on bidict – and also the most surprising, especially in light of the small codebase – is how much fun, advanced Python has turned up in the process.
Check out learning-from-bidict [3] if you’re interested in learning more. (And if that piques your interest, perhaps you’d like to become a reviewer?)
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 is to become a reviewer. If you are interested in reviewing future changes, please +1 this issue.
Doing a complete review of latest master would also be tremendously helpful. There are currently only about 650 lines of code, so a full review may not even take much time.
If you see some code, tests, docs, or anything else that could use improvement, please open an issue or submit a pull request. (On the off chance you finish a review without spotting any issues, please let me know that too!)
If you are interested in getting a guided tour of the codebase to help with your review, I would be happy to try to coordinate a screenshare.
Becoming a Sponsor
If bidict has helped you accomplish your work, especially work you’ve been paid for, please consider supporting bidict’s continued maintenance and development financially if possible, and/or ask your organization to do the same.
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:
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.
