From aca668e44ce2a98b7dfc2996dd83107f2603380b Mon Sep 17 00:00:00 2001 From: vaibhav45sktech Date: Sun, 4 Jan 2026 13:07:18 +0530 Subject: [PATCH 1/5] docs: clarify CLI terminology to align with Databus model (Artifact vs Version) --- databusclient/cli.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/databusclient/cli.py b/databusclient/cli.py index 069408e..7c54b3b 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 Label: the permanent name of the data series (applies to all versions)") +@click.option("--abstract", required=True, help="Version Abstract: a short summary (max 200 chars) specific to this timestamped release") +@click.option("--description", required=True, help="Version Description: detailed metadata for this specific release (supports Markdown)") @click.option( "--license", "license_url", required=True, help="License (see dalicc.net)" ) From 3838bdb61d6d157b87dd26cdc9cf0ff951679ebe Mon Sep 17 00:00:00 2001 From: vaibhav45sktech Date: Sun, 11 Jan 2026 19:49:33 +0530 Subject: [PATCH 2/5] required changes --- databusclient/api/deploy.py | 6 +++--- databusclient/cli.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/databusclient/api/deploy.py b/databusclient/api/deploy.py index ef8ebf5..8c0ba97 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_title: str, + artifact_abstract: str, + artifact_description: str, license_url: str, distributions: List[str], attribution: str = None, diff --git a/databusclient/cli.py b/databusclient/cli.py index 7c54b3b..daa26a4 100644 --- a/databusclient/cli.py +++ b/databusclient/cli.py @@ -25,7 +25,7 @@ def app(): help="Target databus version/dataset identifier of the form " "", ) -@click.option("--title", required=True, help="Artifact Label: the permanent name of the data series (applies to all versions)") +@click.option("--title", required=True, help="Artifact title: the permanent name of the data series (applies to all versions)") @click.option("--abstract", required=True, help="Version Abstract: a short summary (max 200 chars) specific to this timestamped release") @click.option("--description", required=True, help="Version Description: detailed metadata for this specific release (supports Markdown)") @click.option( From a1e144938246954fa3866da072e2501a8db4baae Mon Sep 17 00:00:00 2001 From: vaibhav45sktech Date: Tue, 13 Jan 2026 13:18:39 +0530 Subject: [PATCH 3/5] docs: clarify CLI terminology - rename title/abstract/description to artifact_* --- databusclient/api/deploy.py | 42 ++++++++++++++++++------------------- databusclient/cli.py | 7 ++++++- 2 files changed, 27 insertions(+), 22 deletions(-) diff --git a/databusclient/api/deploy.py b/databusclient/api/deploy.py index 8c0ba97..08ef8f8 100644 --- a/databusclient/api/deploy.py +++ b/databusclient/api/deploy.py @@ -288,11 +288,11 @@ 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 + artifact_title: str The title text of the dataset - abstract: str + artifact_abstract: str A short (one or two sentences) description of the dataset - description: str + artifact_description: str A long description of the dataset. Markdown syntax is supported license_url: str The license of the dataset as a URI. @@ -380,9 +380,9 @@ def create_dataset( artifact_graph = { "@id": artifact_id, "@type": "Artifact", - "title": title, - "abstract": abstract, - "description": description, + "title": artifact_title, + "abstract": artifact_abstract, + "description": artifact_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_title, + "abstract": artifact_abstract, + "description": artifact_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_title: str, + artifact_abstract: str, + artifact_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_title : str + Artifact title: the permanent name of the data series (applies to all versions) + artifact_abstract : str + Version Abstract: a short summary (max 200 chars) specific to this timestamped release + artifact_description : str + Version Description: detailed metadata for this specific release (supports Markdown) 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_title=artifact_title, + artifact_abstract=artifact_abstract, + artifact_description=artifact_description, license_url=license_url, distributions=distributions, ) diff --git a/databusclient/cli.py b/databusclient/cli.py index daa26a4..334807b 100644 --- a/databusclient/cli.py +++ b/databusclient/cli.py @@ -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_title=title, + artifact_abstract=abstract, + artifact_description=description, + license_url=license_url, + distributions=distributions ) api_deploy.deploy(dataid=dataid, api_key=apikey) return From cf6445de9f310ae0ba8e76e8e7b25cd65141cd96 Mon Sep 17 00:00:00 2001 From: vaibhav45sktech Date: Fri, 16 Jan 2026 23:04:35 +0530 Subject: [PATCH 4/5] refactor: rename artifact metadata vars and update CLI help docs --- databusclient/api/deploy.py | 54 ++++++++++++++++++------------------ databusclient/cli.py | 12 ++++---- help_output.txt | Bin 0 -> 3270 bytes tests/test_deploy.py | 6 ++-- 4 files changed, 36 insertions(+), 36 deletions(-) create mode 100644 help_output.txt diff --git a/databusclient/api/deploy.py b/databusclient/api/deploy.py index 08ef8f8..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, - artifact_title: str, - artifact_abstract: str, - artifact_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 - artifact_title: str - The title text of the dataset - artifact_abstract: str - A short (one or two sentences) description of the dataset - artifact_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": artifact_title, - "abstract": artifact_abstract, - "description": artifact_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": artifact_title, - "abstract": artifact_abstract, - "description": artifact_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, - artifact_title: str, - artifact_abstract: str, - artifact_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 - artifact_title : str - Artifact title: the permanent name of the data series (applies to all versions) - artifact_abstract : str - Version Abstract: a short summary (max 200 chars) specific to this timestamped release - artifact_description : str - Version Description: detailed metadata for this specific release (supports Markdown) + 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, - artifact_title=artifact_title, - artifact_abstract=artifact_abstract, - artifact_description=artifact_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 334807b..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="Artifact title: the permanent name of the data series (applies to all versions)") -@click.option("--abstract", required=True, help="Version Abstract: a short summary (max 200 chars) specific to this timestamped release") -@click.option("--description", required=True, help="Version Description: detailed metadata for this specific release (supports Markdown)") +@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)" ) @@ -83,9 +83,9 @@ def deploy( dataid = api_deploy.create_dataset( version_id=version_id, - artifact_title=title, - artifact_abstract=abstract, - artifact_description=description, + artifact_version_title=title, + artifact_version_abstract=abstract, + artifact_version_description=description, license_url=license_url, distributions=distributions ) diff --git a/help_output.txt b/help_output.txt new file mode 100644 index 0000000000000000000000000000000000000000..38afb6e4561752e4dc7be3e1456114c4ba4d537f GIT binary patch literal 3270 zcmds)TW=CU6vxlAiQi!#jHQVz#>Z-!VC$vY3xQHi8XpRULds1RTKeVH-+zYbvI`Y> zGBE^p=ghg^`TeVIiCx)^wQSEK8`*b|ew`o1=f;|8h&riZ> zLED4w0g6jIvx=SD5zkYr*$)RhTZBGCbnXKkpi_jtQ}h}E9iwj-=nYU=IEH(R_da*hKEeJ)`9icY^{BuABkBwwR_Hv2q9kf?KPobZoi())PYhf3VSG0R>8cxGIPE)Mv*(+{!Cr`?Y z6P^J!f}gycT6=~Lih%cz_qF0I4tG$FvDn`hc}nuReX#HR3QH&NOIa?jEaqgC<4}6M zmluUEjy?ii=PAjH(520<^i(FaIghbK-t0W)p_jh?cLJXgHtbo6PgcK}bAww&RGyBV zq#N*FSeYz4pib&||J*@7Q6V~4=J!?LN7REbJ;nu|QLe7nD#fT$d%hm`9o?mi+fQQI zb#K>HY2c}tC{`1fQTa%uJj+lDuZ>Mj-h6IdU}qXlQ3p=yFzO*bv%S9~dcheupSe?n zv;2G=2fb3se}Bv7Qw-;?$W(_?NASH&wIYd4WDbF5iC^HKNixExTIlvmWZ zyw5`CRwe~J^>X?Q8a_e9QL}O^IyB-7IE)t|-I0Sfb4Kb9FIto5k$VS(@jx zZREDi*Dytw>#0T^r*l;?IB}7?C0;|O#o)h)pEjK)p4UWIw^)o@=s?FgoPxs@wlddq zXyT25%b;E0o7DOUuD4KVn_4ARwO*m0M~_(Rx#n{?fHkPrcr z7J@HY8rhD+&TeNr^ZhD#HEdl^$rWA|-l?>d!gr?C8(`{j=@F)w->nk7(I-!{(7a~a nuzGkdcwp7DhHuq7{B+f3?ekBw+5bb)y!Ly&|7W0oAj*M1O&RHi literal 0 HcmV?d00001 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, ) From 304a0ec9211265c425077366ac8aa46388390f93 Mon Sep 17 00:00:00 2001 From: vaibhav45sktech Date: Sat, 17 Jan 2026 22:18:58 +0530 Subject: [PATCH 5/5] Delete help_output.txt --- help_output.txt | Bin 3270 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 help_output.txt diff --git a/help_output.txt b/help_output.txt deleted file mode 100644 index 38afb6e4561752e4dc7be3e1456114c4ba4d537f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3270 zcmds)TW=CU6vxlAiQi!#jHQVz#>Z-!VC$vY3xQHi8XpRULds1RTKeVH-+zYbvI`Y> zGBE^p=ghg^`TeVIiCx)^wQSEK8`*b|ew`o1=f;|8h&riZ> zLED4w0g6jIvx=SD5zkYr*$)RhTZBGCbnXKkpi_jtQ}h}E9iwj-=nYU=IEH(R_da*hKEeJ)`9icY^{BuABkBwwR_Hv2q9kf?KPobZoi())PYhf3VSG0R>8cxGIPE)Mv*(+{!Cr`?Y z6P^J!f}gycT6=~Lih%cz_qF0I4tG$FvDn`hc}nuReX#HR3QH&NOIa?jEaqgC<4}6M zmluUEjy?ii=PAjH(520<^i(FaIghbK-t0W)p_jh?cLJXgHtbo6PgcK}bAww&RGyBV zq#N*FSeYz4pib&||J*@7Q6V~4=J!?LN7REbJ;nu|QLe7nD#fT$d%hm`9o?mi+fQQI zb#K>HY2c}tC{`1fQTa%uJj+lDuZ>Mj-h6IdU}qXlQ3p=yFzO*bv%S9~dcheupSe?n zv;2G=2fb3se}Bv7Qw-;?$W(_?NASH&wIYd4WDbF5iC^HKNixExTIlvmWZ zyw5`CRwe~J^>X?Q8a_e9QL}O^IyB-7IE)t|-I0Sfb4Kb9FIto5k$VS(@jx zZREDi*Dytw>#0T^r*l;?IB}7?C0;|O#o)h)pEjK)p4UWIw^)o@=s?FgoPxs@wlddq zXyT25%b;E0o7DOUuD4KVn_4ARwO*m0M~_(Rx#n{?fHkPrcr z7J@HY8rhD+&TeNr^ZhD#HEdl^$rWA|-l?>d!gr?C8(`{j=@F)w->nk7(I-!{(7a~a nuzGkdcwp7DhHuq7{B+f3?ekBw+5bb)y!Ly&|7W0oAj*M1O&RHi