Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 2.17 KB

README.md

File metadata and controls

39 lines (22 loc) · 2.17 KB
Raw

B2 Python SDK

 Continuous Integration License python versions PyPI version Docs

This repository contains a client library and a few handy utilities for easy access to all of the capabilities of B2 Cloud Storage.

B2 command-line tool is an example of how it can be used to provide command-line access to the B2 service, but there are many possible applications (including FUSE filesystems, storage backend drivers for backup applications etc).

Documentation

The latest documentation is available on Read the Docs.

Installation

The sdk can be installed with:

pip install b2sdk

Version policy

b2sdk follows Semantic Versioning policy, so in essence the version number is MAJOR.MINOR.PATCH (for example 1.2.3) and:

  • we increase MAJOR version when we make incompatible API changes
  • we increase MINOR version when we add functionality in a backwards-compatible manner, and
  • we increase PATCH version when we make backwards-compatible bug fixes (unless someone relies on the undocumented behavior of a fixed bug)

Therefore when setting up b2sdk as a dependency, please make sure to match the version appropriately, for example you could put this in your requirements.txt to make sure your code is compatible with the b2sdk version your user will get from pypi:

b2sdk>=2,<3

Release History

Please refer to the changelog.

Developer Info

Please see our contributing guidelines.