How stable is the BridgeDb API?

An important considerations for developers who want to start using BridgeDb is: How stable is the Application programming interface (API)?

There are two branches of BridgeDb development. Stable branches are even numbered, and unstable branches are odd. Currently, the stable branch of BridgeDb is 1.0. and the unstable branch is 1.1.

For unstable branches: We do not make any guarantees about stability for the unstable branch. Interfaces introduced in the unstable branch may change without warning.

For stable branches: we strive to maintain backwards compatibility for releases with the same major version number. That means that all public methods in 1.0 will work in and 1.2. We might add modules in 1.2 that are not present in 1.0. We might also add deprecation warnings for old methods if we create better alternatives. We will not remove deprecated methods as long as we're still using the same major version number.

major release numbers The only time that we may break backwards compatibility is for releases with a new major release number. For example, there may be API incompatibilities between BridgeDb 2.0 and BridgeDb 1.0. When that happens, we'll provide clear migration instructions. And we'll try to keep supporting older API versions for as long as there is a need.

Click on Roadmap to see which version BridgeDb is currently at, and what the plan is for upcoming releases.