Skip to main content

The bidirectional mapping library for Python.

Status

Latest release Documentation GitHub Actions CI status License PyPI Downloads Sponsor

Features

  • Mature: Depended on by Google, Venmo, CERN, Baidu, Tencent, and teams across the world since 2009

  • Familiar, Pythonic APIs that are carefully designed for safety, simplicity, flexibility, and ergonomics

  • Lightweight, with no runtime dependencies outside Python’s standard library

  • Implemented in concise, well-factored, fully type-hinted Python code that is optimized for running efficiently as well as for long-term maintenance and stability (as well as joy)

  • Extensively documented

  • 100% test coverage running continuously across all supported Python versions (including property-based tests and benchmarks)

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 [1] and proceed from there.

Enterprise Support

Enterprise-level support for bidict can be obtained via the Tidelift subscription or by contacting me directly.

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

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

Voluntary Community Support

Please search through already-asked questions and answers in GitHub Discussions and the issue tracker in case your question has already been addressed.

Otherwise, please feel free to start a new discussion or create a new issue on GitHub for voluntary community support.

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:

Changelog

For bidict release notes, see the changelog. [2]

Release Notifications

Watch bidict releases on GitHub to be notified when new versions of bidict are published. Click the “Watch” dropdown, choose “Custom”, and then choose “Releases”.

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 [3] if you’re interested in learning more.

Contributing

I have been bidict’s sole maintainer and active contributor since I started the project ~15 years ago.

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

Sponsoring

Sponsor through GitHub

Bidict is the product of thousands of hours of my unpaid work over 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:

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 go on 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 companies supporting the open source projects they depend on in this manner:

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:

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bidict-0.24.0.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bidict-0.24.0-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file bidict-0.24.0.tar.gz.

File metadata

  • Download URL: bidict-0.24.0.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for bidict-0.24.0.tar.gz
Algorithm Hash digest
SHA256 3ac3ed76ed1875bd23a5253daa34e7816e7786570d6df8c900c0c64c28634b39
MD5 84e5e7421f8b58ad0692acf077679e51
BLAKE2b-256 16fdedb3e88392853aa0e4b84c6ce44b0040ac79ba1e299ed689a9cb762c22b3

See more details on using hashes here.

File details

Details for the file bidict-0.24.0-py3-none-any.whl.

File metadata

  • Download URL: bidict-0.24.0-py3-none-any.whl
  • Upload date:
  • Size: 36.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for bidict-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 402ee24909d450d438fc5ae7621973817a22f2b9487504dc96954bb861be6f4f
MD5 d4ad652d69892ff210e6cebc35ae5450
BLAKE2b-256 0e5be16e8cefa48c501b64bec8264f480dc45e87bb4c65d5c9ae5ac4252da3df

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.24.0 This release

2 files

0.23.1

2 files

0.23.0

2 files

0.22.1

2 files

0.22.0

2 files

0.21.4

2 files

0.21.3

2 files

0.21.2

2 files

0.21.1

1 file

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.4

1 file

0.18.3

2 files

0.18.2

2 files

0.18.1

2 files

0.18.0

2 files

0.17.5

2 files

0.17.4

2 files

0.17.3

2 files

0.17.2

1 file

0.17.1

1 file

0.17.0

1 file

0.16.0

1 file

0.15.0

1 file

0.14.2

1 file

0.14.1

1 file

0.14.0

1 file

0.13.1

1 file

0.13.0

1 file

0.12.0

1 file

0.11.0

1 file

0.10.0.post1

1 file

0.10.0

1 file

0.9.0.post1

1 file

0.3.1

1 file

0.3.0

1 file

0.2.1

1 file

0.1.5

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page