| Name | pyhandle JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | Library for management of handles |
| upload_time | 2023-01-30 09:42:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6, <3.11 |
| license | Apache License 2.0 |
| keywords |
handles
pids
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PYHANDLE
PyHandle is a Python client library for interaction with a [Handle System](https://handle.net) server, providing basic create, read, update and delete capabilities for Handles. The library offers a client for the HTTP REST interface. It also includes a client that interacts directly with a Handle server SQL back-end and a client that creates customized Batch files (containing Batch operations that can be performed using the GenericBatch command utility provided by the Handle System), but those two are no longer maintained.
PyHandle currently supports Python >=3.5 (tested up to 3.10), and requires at least a Handle System server 9. The library requires OpenSSL v1.0.1 or higher. Python 2.7 and 3.10 are supported.
PyHandle is based on a prior development of the [EUDAT project](https://eudat.eu) under the name B2Handle.
As [B2Handle](https://github.com/EUDAT-B2SAFE/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.
We advice you to use PyHandle isteard of B2HADNLE.
# Installation
You can install the PyHandle library as follows:
```bash
git clone https://github.com/EUDAT-B2SAFE/PYHANDLE.git
cd PYHANDLE/
python setup.py install
```
The library is also available on PyPi and can be installed via pip:
```bash
pip install pyhandle
```
For more information on the methods offered by the library, please consult the [technical documentation](http://eudat-b2handle.github.io/PYHANDLE/).
## Instantiate:
One of the core steps is to instantiate the file with the needed credentials.
A guide on how to use them is the following:
```
credentials_file = './credentials/creds.json'
# Path must be relative to current working dir
# JSON file must contain absolute paths, or paths relative to the creds.json file!!
creds = pyhandle.clientcredentials.PIDClientCredentials.load_from_JSON(credentials_file)
client = pyhandle.handleclient.PyHandleClient('rest').instantiate_with_credentials(
creds, HTTPS_verify=https_verify)
```
# Link to documentation
Check out the technical documentation [here](https://eudat-b2handle.github.io/PYHANDLE/).
Check out the overall documentation [here](https://eudat-b2handle.github.io/).
# License
Copyright 2015-2022, 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.
# Github contributions
Devs:
* Please make contributions based on the devel branch, then issue a PR to the devel branch.
* Small contributions (e.g. typos, README, ...) can be pushed directly to devel if you have permissions.
Owners:
* Run unit tests on PR
* Merged PR into devel
* If/when changes are ready for a next release, bump the version number (no PR, but push directly to the repo)
* Run unit tests again on this devel branch.
* Merge devel into master (no PR, directly merge them **with --no-ff to keep history** and push to master)
* Add "-dev" to the incremented version number on devel
* Send release to pypi:
Raw data
{
"_id": null,
"home_page": "",
"name": "pyhandle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <3.11",
"maintainer_email": "",
"keywords": "handles,PIDs",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/35/aa/0e53b186671f51314903b17f074f38796ed2a8d9ffe4ace4f4e6263adf05/pyhandle-1.2.1.tar.gz",
"platform": null,
"description": "# PYHANDLE\n\nPyHandle is a Python client library for interaction with a [Handle System](https://handle.net) server, providing basic create, read, update and delete capabilities for Handles. The library offers a client for the HTTP REST interface. It also includes a client that interacts directly with a Handle server SQL back-end and a client that creates customized Batch files (containing Batch operations that can be performed using the GenericBatch command utility provided by the Handle System), but those two are no longer maintained.\n\nPyHandle currently supports Python >=3.5 (tested up to 3.10), and requires at least a Handle System server 9. The library requires OpenSSL v1.0.1 or higher. Python 2.7 and 3.10 are supported. \n\nPyHandle is based on a prior development of the [EUDAT project](https://eudat.eu) under the name B2Handle.\nAs [B2Handle](https://github.com/EUDAT-B2SAFE/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.\n\nWe advice you to use PyHandle isteard of B2HADNLE. \n\n\n# Installation\n\nYou can install the PyHandle library as follows:\n\n```bash\ngit clone https://github.com/EUDAT-B2SAFE/PYHANDLE.git\ncd PYHANDLE/\npython setup.py install\n```\n\nThe library is also available on PyPi and can be installed via pip:\n\n```bash\n pip install pyhandle\n```\n\nFor more information on the methods offered by the library, please consult the [technical documentation](http://eudat-b2handle.github.io/PYHANDLE/).\n\n## Instantiate:\n\nOne of the core steps is to instantiate the file with the needed credentials. \nA guide on how to use them is the following: \n\n```\ncredentials_file = './credentials/creds.json'\n# Path must be relative to current working dir\n# JSON file must contain absolute paths, or paths relative to the creds.json file!!\ncreds = pyhandle.clientcredentials.PIDClientCredentials.load_from_JSON(credentials_file)\nclient = pyhandle.handleclient.PyHandleClient('rest').instantiate_with_credentials(\n creds, HTTPS_verify=https_verify)\n```\n\n\n# Link to documentation\n\nCheck out the technical documentation [here](https://eudat-b2handle.github.io/PYHANDLE/).\n\nCheck out the overall documentation [here](https://eudat-b2handle.github.io/).\n\n\n# License\n\nCopyright 2015-2022, Deutsches Klimarechenzentrum GmbH, GRNET S.A., SURFsara\n\n The PYHANDLE library is licensed under the Apache License,\n Version 2.0 (the \"License\"); you may not use this product except in \n compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\n# Github contributions\n\nDevs:\n\n* Please make contributions based on the devel branch, then issue a PR to the devel branch.\n* Small contributions (e.g. typos, README, ...) can be pushed directly to devel if you have permissions.\n\nOwners:\n\n* Run unit tests on PR\n* Merged PR into devel\n* If/when changes are ready for a next release, bump the version number (no PR, but push directly to the repo)\n* Run unit tests again on this devel branch.\n* Merge devel into master (no PR, directly merge them **with --no-ff to keep history** and push to master)\n* Add \"-dev\" to the incremented version number on devel\n* Send release to pypi: \n\n\n\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Library for management of handles",
"version": "1.2.1",
"split_keywords": [
"handles",
"pids"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f5ee959a063a8746da34aa860700217398da6061e40e04dea4b366c0428500f",
"md5": "fa0ed744a6626470d8a3530411fa5409",
"sha256": "99ac2bfa5f295afc3f3332ce47ee243d326c4935f3f27098a9dca1436cf7671a"
},
"downloads": -1,
"filename": "pyhandle-1.2.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa0ed744a6626470d8a3530411fa5409",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6, <3.11",
"size": 101872,
"upload_time": "2023-01-30T09:42:43",
"upload_time_iso_8601": "2023-01-30T09:42:43.646606Z",
"url": "https://files.pythonhosted.org/packages/4f/5e/e959a063a8746da34aa860700217398da6061e40e04dea4b366c0428500f/pyhandle-1.2.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35aa0e53b186671f51314903b17f074f38796ed2a8d9ffe4ace4f4e6263adf05",
"md5": "4a30e3c7e0e0f03b02928052a955d18c",
"sha256": "1747444999a8e8ccfcdc2c2cd37ca9cf93c45fd06a1854d4e84a83ebd60f1439"
},
"downloads": -1,
"filename": "pyhandle-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4a30e3c7e0e0f03b02928052a955d18c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <3.11",
"size": 76544,
"upload_time": "2023-01-30T09:42:45",
"upload_time_iso_8601": "2023-01-30T09:42:45.325528Z",
"url": "https://files.pythonhosted.org/packages/35/aa/0e53b186671f51314903b17f074f38796ed2a8d9ffe4ace4f4e6263adf05/pyhandle-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 09:42:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pyhandle"
}
