A lightweight python package for accessing handle services
Project description
easyhandle
A lightweight python package for accessing handle services.
Installation
This python package can be installed using pip
.
pip install easyhandle
Getting Started
This library provides different HandleClient classes (e.g. BasicAuthHandleClient), differing in the way authentication is handled.
All clients inherit from the super class HandleClient
.
Instantiating the client
object
To instantiate a client object either use its constructor:
client = HandleClient('https://hdl.handle.net',
prefix='TEST',
verify=True)
or the respective classmethod load_from_config
:
client = HandleClient.load_from_config({
'handle_server_url': 'https://hdl.handle.net',
'prefix': 'TEST',
'HTTPS_verify': True
})
Usage
All methods described below return the according Response
object of the request submitted to the handle server
To create a new handle entry (requires authentication) use the put_handle
method, e.g.:
client.put_handle({
'handle': 'TEST/0aca26ca-016f-11eb-adc1-0242ac120002'
'values': [
{
'index': 1,
'type': 'URL',
'data': {
'format': 'string',
'value': 'https://www.google.com'
}
]
})
To retrieve a handle record use the get_handle
method, e.g.:
client.get_handle('TEST/0aca26ca-016f-11eb-adc1-0242ac120002')
To delete a handle record use the delete_handle
method, e.g.:
client.delete_handle('TEST/0aca26ca-016f-11eb-adc1-0242ac120002')
Available Clients
BasicAuthHandleClient
Required config properties:
Name | Description | Default |
---|---|---|
handle_server_url | base url to the handle service | https://hdl.handle.net |
prefix | handle prefix used, when new PIDs are issued | |
HTTPS_verify | defines wehter the server certificate should be validated | True |
username | username used for basic authentication | |
password | password used for basic authentication |
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
Built Distributions
Hashes for easyhandle-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ff2116d06aab1f8965adf555845ac02ec20811f9341c51dea32bcad62b03353 |
|
MD5 | 2e3ffb5fdbbeee0b2ef172f0cf314477 |
|
BLAKE2b-256 | 3f314e00bc5cb28dde8970c74f8478c411a335f64b028a07c168b18a8384f8e0 |
Hashes for easyhandle-0.0.7-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 239ce12569e1921e0f363d7d461e2615c8852a3cc67cec2917b88ca7e3339daa |
|
MD5 | 6549775a75715db5e14fc38b8a874edd |
|
BLAKE2b-256 | 4d0920d854829eeefd7e8930694340e2c6a3a56f9ebe88509ba1f777fcb5ee59 |