hsclient

一个用于以面向对象方式与HydroShare交互的Python客户端。

Jupyter Notebooks

HydroShare有一个包含示例notebooks的资源。点击这里，然后点击蓝色 使用...打开 下拉菜单并选择 Cuahsi Jupyterhub 以启动notebooks到Jupyter环境，开始使用此项目。

安装HS RDF HydroShare Python客户端

默认情况下不会安装HS RDF Python客户端，因此您必须首先安装它才能使用它。使用以下命令从GitHub仓库安装Python客户端。最终我们将通过Python包索引（PyPi）分发此包，以便可以通过pip从PyPi安装。

pip install hsclient

使用HydroShare进行身份验证

在您开始与HydroShare中的资源交互之前，您需要进行身份验证。

from hsclient import HydroShare

hs = HydroShare()
hs.sign_in()

创建一个新的空资源

"资源"是您在HydroShare中内容的容器。将其视为一个"工作目录"，您将在这里组织要使用和共享的代码和/或数据。以下代码可以用来创建一个新的空资源，您可以在其中创建内容和元数据。

此代码在HydroShare中创建了一个新资源。它还在您的本地环境中创建了这个资源的内存对象表示，您可以使用更多代码来操作它。

# 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)

创建和编辑资源元数据元素

资源元数据的编辑可以采用面向对象的方式进行。您可以在代码中指定所有元数据元素，这将设置它们在本地环境中的内存值。元数据元素的值可以编辑、删除或替换，方法是将它们设置为新的值、追加新的值（如果元数据元素接受列表），或者完全删除该值。

当您准备好将本地环境中对元数据元素的编辑保存到HydroShare中的资源时，您可以在您的资源上调用save()函数，您创建/编辑的所有新元数据值都将保存到HydroShare中的资源。

资源标题和摘要

标题和摘要元数据元素可以指定为文本字符串。要在设置后修改标题或摘要，只需将它们设置为不同的值。

# 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)