# B2 Python SDK
 [![Continuous Integration](https://github.com/Backblaze/b2-sdk-python/workflows/Continuous%20Integration/badge.svg)](https://github.com/Backblaze/b2-sdk-python/actions?query=workflow%3A%22Continuous+Integration%22) [![License](https://img.shields.io/pypi/l/b2sdk.svg?label=License)](https://pypi.python.org/pypi/b2) [![python versions](https://img.shields.io/pypi/pyversions/b2sdk.svg?label=python%20versions)](https://pypi.python.org/pypi/b2sdk) [![PyPI version](https://img.shields.io/pypi/v/b2sdk.svg?label=PyPI%20version)](https://pypi.python.org/pypi/b2sdk) [![Docs](https://readthedocs.org/projects/b2-sdk-python/badge/?version=master)](https://b2-sdk-python.readthedocs.io/en/master/)



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](https://github.com/Backblaze/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](https://b2-sdk-python.readthedocs.io).

# Installation

The sdk can be installed with:

    pip install b2sdk

# Version policy

b2sdk follows [Semantic Versioning](https://semver.org/) 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>=0.0.0,<1.0.0
```

# Release History

Please refer to the [changelog](CHANGELOG.md).

# Developer Info

Please see our [contributing guidelines](CONTRIBUTING.md).

# Release Process

- Get the Nox:
  - `pip install -U nox`
- Update the release history in `CHANGELOG.md`:
  - Change "Unreleased" to the current release version and date.
  - Create empty "Unreleased" section.
  - Add proper link to the new release (at the bottom of the file). Use GitHub [compare feature](https://docs.github.com/en/free-pro-team@latest/github/committing-changes-to-your-project/comparing-commits#comparing-tags) between two tags.
  - Update "Unreleased" link (at the bottom of the file).
- Run linters and tests:
  - `export B2_TEST_APPLICATION_KEY=your_app_key`
  - `export B2_TEST_APPLICATION_KEY_ID=your_app_key_id`
  - `nox -x`
- Build docs locally:
  - `nox --non-interactive -xs doc`
- Commit and push to GitHub, then wait for CI workflow to complete successfully.
  - No need to make a branch. Push straight to `master`.
- Tag in git and push tag to origin.  (Version tags look like "v0.4.6".)
  - `git tag vx.x.x`
  - `git push origin vx.x.x`
- Wait for CD workflow to complete successfully.
  - Verify that the GitHub release is created
  - Verify that the release has been uploaded to the PyPI
- Install using pip and verify that it gets the correct version:
  - `pip install -U b2sdk`