Skip to main content

Library for management of handles in the EUDAT project.

Project description


The b2handle Python library is a client library for interaction with a Handle System server, using the native REST interface introduced in Handle System 8. The library offers methods to create, update and delete Handles as well as advanced functionality such as searching over Handles using an additional search servlet and managing multiple location entries per Handle.

The library currently supports Python 2.6, 2.7, 3.5, 3.6 and 3.7, and requires at least a Handle System server 8.1. The library requires OpenSSL v1.0.1 or higher.

Test Coverage and Continuous Integration

Test status of the devel branch:

Build Status (click here to check out test coverage)

B2Handle has a unit test coverage of approximately 90%. Every addition to the devel branch is automatically unit tested. The test can be found in b2handle/tests and easily run using the command “python”. For the current test coverage, please click on the badge and link above.

In addition to the unit tests, integration tests cover the reading, writing and searching of handles. As these needs credentials and write access to a real server, these are not run on GitHub. However, every user with access to a handle server can add their own credentials and run the integration tests in his/her system (using the command “python testtype write”, or “read”, or “search”, or all three).

Installation and use

Build an egg:

python bdist_egg

Install the library via pip:

pip install <egg file>

For more information on the methods offered by the library, please consult the technical documentation. The documentation also contains information on how to set up correct certificates for the Handle Server so it accepts modification REST requests and how to set up client authentication using public keys.

Docker support

The library can also be used in combination with Docker. The Dockerfile contains instructions for building a Docker image with the B2HANDLE library installed.

Base Docker Image


  1. Install Docker.

  2. Build an image from Dockerfile: docker build -t eudat-b2handle .

Running Python

docker run -it --rm eudat-b2handle python

Python 2.7.9 (default, Mar  1 2015, 12:57:24)
[GCC 4.9.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from b2handle.handleclient import EUDATHandleClient

Building the documentation

B2Handle uses Sphinx for documentation, requiring at least version 1.3. Sphinx can be installed via pip. To build HTML documentation locally, then run:

python build_sphinx

Developer team

Machines don’t write software, people do. Please refer to to learn about those who spent effort in creating this product.


Copyright 2015-2016, Deutsches Klimarechenzentrum GmbH, GRNET S.A., SURFsara

The B2Handle library is licensed under the Apache License, Version 2.0 (the “License”); you may not use this product except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details

Download files

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

Source Distribution

b2handle-1.1.2.tar.gz (73.8 kB view hashes)

Uploaded Source

Built Distributions

b2handle-1.1.2-py3.7.egg (225.7 kB view hashes)

Uploaded Source

b2handle-1.1.2-py3.6.egg (225.8 kB view hashes)

Uploaded Source

b2handle-1.1.2-py3.5.egg (228.9 kB view hashes)

Uploaded Source

b2handle-1.1.2-py2.py3-none-any.whl (106.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page