Repository files navigation

The bidirectional mapping library for Python.

• Mature: Depended on byGoogle, Venmo, CERN, Baidu, Tencent,and teams across the world since 2009
• Familiar, Pythonic APIsthat are carefully designed forsafety, simplicity, flexibility, and ergonomics
• Lightweight, with no runtime dependenciesoutside Python's standard library
• Implemented inconcise, well-factored, fully type-hinted Python codethat is optimized for running efficientlyas well as for long-term maintenance and stability(as well asjoy)
• Extensivelydocumented
• 100% test coveragerunning continuously across all supported Python versions(including property-based tests and benchmarks)

pip install bidict

>>>frombidictimportbidict>>>element_by_symbol=bidict({'H':'hydrogen'})>>>element_by_symbol['H']'hydrogen'>>>element_by_symbol.inverse['hydrogen']'H'

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

Enterprise-level support for bidict can be obtained via theTidelift subscriptionor bycontacting me directly.

I have a US-based LLC set up for invoicing,and I have 15+ years of professional experiencedelivering software and support to companies successfully.

You can also sponsor my work through several platforms, including GitHub Sponsors.See theSponsoring section below for details,including rationale and examples of companiessupporting the open source projects they depend on.

Please search through already-asked questions and answersinGitHub Discussionsand theissue trackerin case your question has already been addressed.

Otherwise, please feel free tostart a new discussionorcreate a new issue on GitHubfor voluntary community support.

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:

• star bidict on GitHub
• post inGitHub Discussions
• email me

For bidict release notes, see thechangelog.[2]

Watchbidict releases on GitHubto be notified when new versions of bidict are published.Click the "Watch" dropdown, choose "Custom", and then choose "Releases".

One of the best things about bidictis that it touches a surprising number ofinteresting Python corners,especially given its small size and scope.

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

I have been bidict's sole maintainerandactive contributorsince I started the project ~15 years ago.

Your help would be most welcome!See thecontributors-guide[4]for more information.

Bidict is the product of thousands of hours of my unpaid workover the 15+ years that I've been the sole maintainer.

If bidict has helped you or your company accomplish your work,please sponsor my work through one of the following,and/or ask your company to do the same:

• GitHub
• PayPal
• Tidelift
• thanks.dev
• Gumroad
• a support engagement with my LLC

If you're not sure which to use, GitHub is an easy option,especially if you already have a GitHub account.Just choose a monthly or one-time amount, and GitHub handles everything else.Your bidict sponsorship on GitHub will automatically goon the same regular bill as any other GitHub charges you pay for.PayPal is another easy option for one-time contributions.

See the following for rationale and examples of companiessupporting the open source projects they depend onin this manner:

• https://engineering.atspotify.com/2022/04/announcing-the-spotify-foss-fund/
• https://blog.sentry.io/2021/10/21/we-just-gave-154-999-dollars-and-89-cents-to-open-source-maintainers
• https://engineering.indeedblog.com/blog/2019/07/foss-fund-six-months-in/

If you're viewing this onhttps://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 documentationthat corresponds to the version of bidict you'd like to use.

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