Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

B2 python SDK

 Travis CI 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).

Installation

The sdk can be installed with:

pip install b2sdk

If you see a message saying that the six library cannot be installed, which happens if you're installing with the system python on OS X El Capitan, try this:

pip install --ignore-installed 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>=0.0.0,<1.0.0

Release History

1.0.0-rc1 (not released yet)

Changes:

  • Deprecate some transitional method names to v0 in preparation for v1.0.0.

0.1.10 (2019-07-09)

Changes:

  • Remove a parameter (which did nothing, really) from b2sdk.v1.Bucket.copy_file signature

0.1.8 (2019-06-28)

Changes:

  • Add support for b2_copy_file
  • Add support for prefix parameter on ls-like calls

0.1.6 (2019-04-24)

Changes:

  • Fix transferer crashing on empty file download attempt
  • Rename account ID for authentication to application key ID. Account ID is still backwards compatible, only the terminology has changed.

0.1.4 (2019-04-04)

Initial official release of SDK as a separate package (until now it was a part of B2 CLI)

Developer Info

We encourage outside contributors to perform changes on our codebase. Many such changes have been merged already. In order to make it easier to contribute, core developers of this project:

  • provide guidance (through the issue reporting system)
  • provide tool assisted code review (through the Pull Request system)
  • maintain a set of integration tests (run with a production cloud)
  • maintain a set of (well over a hundred) unit tests
  • automatically run unit tests on 13 versions of python (including osx and pypy)
  • format the code automatically using yapf
  • use static code analysis to find subtle/potential issues with maintainability
  • maintain other Continous Integration tools (coverage tracker)

You'll need to some Python packages installed. To get all the latest things:

  • pip install --upgrade --upgrade-strategy eager -r requirements.txt -r requirements-test.txt -r requirements-setup.txt

There is a Makefile with a rule to run the unit tests using the currently active Python:

make setup
make test

will install the required packages, then run the unit tests.

To test in multiple python virtual environments, set the enviroment variable PYTHON_VIRTUAL_ENVS to be a space-separated list of their root directories. When set, the makefile will run the unit tests in each of the environments.

Before checking in, use the pre-commit.sh script to check code formatting, run unit tests, run integration tests etc.

The integration tests need a file in your home directory called .b2_auth that contains two lines with nothing on them but your application key ID and application key:

 applicationKeyId
 applicationKey

We marked the places in the code which are significantly less intuitive than others in a special way. To find them occurrences, use git grep '*magic*'.

Metadata

Release files for b2sdk 1.0.0rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for b2sdk 1.0.0rc1
File Size Uploaded Provenance Actions
b2sdk-1.0.0rc1.tar.gz 87.6 kB Without provenance Details for b2sdk-1.0.0rc1.tar.gz

Release files / b2sdk-1.0.0rc1.tar.gz

Download URL b2sdk-1.0.0rc1.tar.gz
Size 87.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0331496b2cf18749d281c0abb8f355bed54f0cf7ea56c202f24a8198536344c0
BLAKE2b-256 checksum
How to use checksums
0df2d725967298d045762b35805072d57f29039312c84648b8a60ca50eca4a6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

Security for b2sdk 1.0.0rc1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page