diff --git a/databusclient/api/deploy.py b/databusclient/api/deploy.py index ef8ebf5..aa80619 100644 --- a/databusclient/api/deploy.py +++ b/databusclient/api/deploy.py @@ -268,9 +268,9 @@ def _create_distributions_from_metadata( def create_dataset( version_id: str, - title: str, - abstract: str, - description: str, + artifact_version_title: str, + artifact_version_abstract: str, + artifact_version_description: str, license_url: str, distributions: List[str], attribution: str = None, @@ -288,12 +288,12 @@ def create_dataset( ---------- version_id: str The version ID representing the Dataset. Needs to be in the form of $DATABUS_BASE/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION - title: str - The title text of the dataset - abstract: str - A short (one or two sentences) description of the dataset - description: str - A long description of the dataset. Markdown syntax is supported + artifact_version_title: str + Artifact & Version Title: used for BOTH artifact and version. Keep stable across releases; identifies the data series. + artifact_version_abstract: str + Artifact & Version Abstract: used for BOTH artifact and version (max 200 chars). Updating it changes both artifact and version metadata. + artifact_version_description: str + Artifact & Version Description: used for BOTH artifact and version. Supports Markdown. Updating it changes both artifact and version metadata. license_url: str The license of the dataset as a URI. distributions: str @@ -380,9 +380,9 @@ def create_dataset( artifact_graph = { "@id": artifact_id, "@type": "Artifact", - "title": title, - "abstract": abstract, - "description": description, + "title": artifact_version_title, + "abstract": artifact_version_abstract, + "description": artifact_version_description, } graphs.append(artifact_graph) @@ -392,9 +392,9 @@ def create_dataset( "@type": ["Version", "Dataset"], "@id": _versionId, "hasVersion": version, - "title": title, - "abstract": abstract, - "description": description, + "title": artifact_version_title, + "abstract": artifact_version_abstract, + "description": artifact_version_description, "license": license_url, "distribution": distribution_list, } @@ -470,9 +470,9 @@ def deploy( def deploy_from_metadata( metadata: List[Dict[str, Union[str, int]]], version_id: str, - title: str, - abstract: str, - description: str, + artifact_version_title: str, + artifact_version_abstract: str, + artifact_version_description: str, license_url: str, apikey: str, ) -> None: @@ -485,12 +485,12 @@ def deploy_from_metadata( List of file metadata entries (see _create_distributions_from_metadata) version_id : str Dataset version ID in the form $DATABUS_BASE/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION - title : str - Dataset title - abstract : str - Short description of the dataset - description : str - Long description (Markdown supported) + artifact_version_title : str + Artifact & Version Title: used for BOTH artifact and version. + artifact_version_abstract : str + Artifact & Version Abstract: used for BOTH artifact and version. + artifact_version_description : str + Artifact & Version Description: used for BOTH artifact and version. license_url : str License URI apikey : str @@ -500,9 +500,9 @@ def deploy_from_metadata( dataset = create_dataset( version_id=version_id, - title=title, - abstract=abstract, - description=description, + artifact_version_title=artifact_version_title, + artifact_version_abstract=artifact_version_abstract, + artifact_version_description=artifact_version_description, license_url=license_url, distributions=distributions, ) diff --git a/databusclient/cli.py b/databusclient/cli.py index 069408e..f4e49c3 100644 --- a/databusclient/cli.py +++ b/databusclient/cli.py @@ -25,9 +25,9 @@ def app(): help="Target databus version/dataset identifier of the form " "", ) -@click.option("--title", required=True, help="Dataset title") -@click.option("--abstract", required=True, help="Dataset abstract max 200 chars") -@click.option("--description", required=True, help="Dataset description") +@click.option("--title", required=True, help="Artifact & Version Title: used for BOTH artifact and version. Keep stable across releases; identifies the data series.") +@click.option("--abstract", required=True, help="Artifact & Version Abstract: used for BOTH artifact and version (max 200 chars). Updating it changes both artifact and version metadata.") +@click.option("--description", required=True, help="Artifact & Version Description: used for BOTH artifact and version. Supports Markdown. Updating it changes both artifact and version metadata.") @click.option( "--license", "license_url", required=True, help="License (see dalicc.net)" ) @@ -82,7 +82,12 @@ def deploy( click.echo(f"Deploying dataset version: {version_id}") dataid = api_deploy.create_dataset( - version_id, title, abstract, description, license_url, distributions + version_id=version_id, + artifact_version_title=title, + artifact_version_abstract=abstract, + artifact_version_description=description, + license_url=license_url, + distributions=distributions ) api_deploy.deploy(dataid=dataid, api_key=apikey) return diff --git a/tests/test_deploy.py b/tests/test_deploy.py index aada04c..679f11f 100644 --- a/tests/test_deploy.py +++ b/tests/test_deploy.py @@ -93,9 +93,9 @@ def test_empty_cvs(): dataset = create_dataset( version_id="https://dev.databus.dbpedia.org/user/group/artifact/1970.01.01/", - title="Test Title", - abstract="Test abstract blabla", - description="Test description blabla", + artifact_version_title="Test Title", + artifact_version_abstract="Test abstract blabla", + artifact_version_description="Test description blabla", license_url="https://license.url/test/", distributions=dst, )