pyhandle 1.0.4

Library for management of handles

PYHANDLE

PyHandle is a Python client library for interaction with a Handle System server, providing basic create, read, update and delete capabilities for Handles. The library offers a client for the HTTP REST interface, a client that interacts directly with a Handle server SQL back-end and a client that creates customized Batch files. The latter contain Batch operations, that can be performed using the GenericBatch command utility provided by the Handle System.

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

PyHandle is based on a prior development of the EUDAT project under the name B2Handle. As B2Handle was developed with a specific scope - Handle operations in the EUDAT project - in mind, it has been improved and made more generic to cater to a broader audience.

Installation

You can install the PyHandle library as follows: 1. git clone https://github.com/EUDAT-B2SAFE/PYHANDLE.git 1. cd PYHANDLE/ 1. python setup.py install

The library is also available on PyPi and can be installed via pip:

pip install pyhandle

For more information on the methods offered by the library, please consult the technical documentation. # Building the documentation

For more details about the library you can build the documention using Sphinx, requiring at least version 1.3. Sphinx and can be installed via pip. To build HTML documentation locally, then run:

python setup.py build_sphinx

Link to documentation

Check out the documentation here.

(You can find the source here in this repository at /docs/source/index.rst!)

License

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

The PYHANDLE 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

http://www.apache.org/licenses/LICENSE-2.0

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.

Some usage notes

(to be migrated to documentation)

• register_handle_kv(handle, **kv-pairs) allows to pass (additionally to the handle name) key-value pairs.

• register_handle_json(handle, list_of_entries, ...) allow to pass JSON snippets instead of key-value pairs, so you can specify the indices. An entry looks like this: {'index':index, 'type':entrytype, 'data':data}. This is the format in which the changes are communicated to the handle server via its REST interface. An entry of type HS_ADMIN will be added if you do not provide one.

• register_handle(...) allows to pass (additionally to the handle name) a mandatory URL, and optionally a CHECKSUM, and more types as key-value pairs. Old method, made for legacy reasons, as this library was created to replace an earlier library that had a method with specifically this signature.

• generate_and_register_handle(prefix, ...) is a similar legacy method. Instead, just use generate_PID_name(prefix) to create a handle name and use one of the above.

How to run the unit tests

The simplest way (tested with python 3.7.1):

python setup.py test

Also look at pyhandle/tests/README.md.