Skip to main content

A python client for managing HydroShare resources

Project description

hsclient

A python client for interacting with HydroShare in an object oriented way.

Jupyter Notebooks

HydroShare has a resource with example notebooks. Click here then click the blue Open with... dropdown and select Cuahsi Jupyterhub to launch the notebooks into a Jupyter Environment to start using this project.

Install the HS RDF HydroShare Python Client

The HS RDF Python Client for HydroShare won't be installed by default, so it has to be installed first before you can work with it. Use the following command to install the Python Client from the GitHub repository. Eventually we will distribute this package via the Python Package Index (PyPi) so that it can be installed via pip from PyPi.

pip install hsclient

Authenticate with HydroShare

Before you start interacting with resources in HydroShare you will need to authenticate.

from hsclient import HydroShare

hs = HydroShare()
hs.sign_in()

Create a New Empty Resource

A "resource" is a container for your content in HydroShare. Think of it as a "working directory" into which you are going to organize the code and/or data you are using and want to share. The following code can be used to create a new, empty resource within which you can create content and metadata.

This code creates a new resource in HydroShare. It also creates an in-memory object representation of that resource in your local environmment that you can then manipulate with further code.

# Create the new, empty resource
new_resource = hs.create()

# Get the HydroShare identifier for the new resource
resIdentifier = new_resource.resource_id
print('The HydroShare Identifier for your new resource is: ' + resIdentifier)

# Construct a hyperlink for the new resource
print('Your new resource is available at: ' +  new_resource.metadata.url)

Creating and Editing Resource Metadata Elements

Editing metadata elements for a resource can be done in an object oriented way. You can specify all of the metadata elements in code, which will set their values in memory in your local environment. Values of metadata elements can be edited, removed, or replaced by setting them to a new value, appending new values (in the case where the metadata element accepts a list), or by removing the value entirely.

When you are ready to save edits to metadata elements from your local environment to the resource in HydroShare, you can call the save() function on your resource and all of the new metadata values you created/edited will be saved to the resource in HydroShare.

Resource Title and Abstract

The Title and Abstract metadata elements can be specified as text strings. To modify the Title or Abstract after it has been set, just set them to a different value.

# Set the Title for the resource
new_resource.metadata.title = 'Resource for Testing the HS RDF HydroShare Python Client'

# Set the Abstract text for the resource
new_resource.metadata.abstract = (
    'This resource was created as a demonstration of using the HS RDF ' 
    'Python Client for HydroShare. Once you have completed all of the '
    'steps in this notebook, you will have a fully populated HydroShare '
    'Resource.'
)

# Call the save function to save the metadata edits to HydroShare
new_resource.save()

# Print the title just added to the resource
print('Title: ' + new_resource.metadata.title)
print('Abstract: ' + new_resource.metadata.abstract)

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

hsclient-1.0.1.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

hsclient-1.0.1-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file hsclient-1.0.1.tar.gz.

File metadata

  • Download URL: hsclient-1.0.1.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hsclient-1.0.1.tar.gz
Algorithm Hash digest
SHA256 039bd5906427d7cfebee4a38c418435a34c4c208d4c3289052ce743a626dc2a3
MD5 ff685010ae6f659fcc1425f71b2032ec
BLAKE2b-256 85a4b7336e9a5b2b0590d92f78ecbea46aa0d2be56aaadcfd7cd660cc7ce9f45

See more details on using hashes here.

Provenance

File details

Details for the file hsclient-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: hsclient-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hsclient-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35c183680130345345921e1ebd71ffcb4c18275c46fddb03b2bee0d723a1b539
MD5 02c522fd67ce7d5cbaf5dc5adce43a83
BLAKE2b-256 c845e25aec8411d7d1a84034837a9f059ab7e2b7d528fc5d76eef8a39c9d7bc2

See more details on using hashes here.

Provenance

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