# PR: Release databusclient 0.15 to PyPI (Issue #35) (#41)

* Restrict Vault token exchange to specific hosts; improve auth errors; add tests (fixes #19)

* Restrict Vault token exchange to specific hosts; improve auth errors; add tests and docs note (fixes #19)

* Release 0.15: bump version, add changelog, docstrings(issue #35)

* Prepare PyPI release 0.15 with build artifacts and publishing guide (Issue #35)

* Convert all docstrings to Google-style format

---------

Co-authored-by: DhanashreePetare <[email protected]>
Co-authored-by: Fabian Hofer <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.15] - 2025-12-31
+
+### Added
+- Vault authentication improvements with host-restricted token exchange
+- Comprehensive tests for Vault authentication behavior
+- Enhanced docstrings across all modules for better documentation coverage
+- Support for download redirect handling
+
+### Fixed
+- Vault token exchange now restricted to known hosts for improved security
+- Clearer authentication error messages
+- README instructions now consistent with PyPI release
+
+### Changed
+- Updated CLI usage documentation to reflect current command structure
+- Improved error handling in download operations
+
+### Notes
+- Version 0.15 skips 0.13 and 0.14 as requested in issue #35
+- This release updates the PyPI package to align with current repository features

README.md

@@ -41,6 +41,12 @@ Before using the client, install it via pip:
 python3 -m pip install databusclient
 ```
 
+Note: the PyPI release was updated and this repository prepares version `0.15`. If you previously installed `databusclient` via `pip` and observe different CLI behavior, upgrade to the latest release:
+
+```bash
+python3 -m pip install --upgrade databusclient==0.15
+```
+
 You can then use the client in the command line:
 
 ```bash

RELEASE_NOTES.md

@@ -0,0 +1,97 @@
+# Release Notes for databusclient 0.15
+
+## Overview
+This release addresses issue #35 by providing a new PyPI package (version 0.15) to ensure `pip install databusclient` provides the latest CLI features and bug fixes.
+
+## Version
+**0.15** (skipping 0.13 and 0.14 as requested)
+
+## What's New
+
+### Features & Improvements
+- **Vault Authentication Enhancement**: Host-restricted token exchange for improved security
+- **Better Error Messages**: Clearer authentication error messages for easier debugging
+- **Download Redirect Handling**: Improved handling of redirects during file downloads
+- **Comprehensive Documentation**: Enhanced docstrings across all modules
+
+### Bug Fixes
+- Fixed Vault token exchange to only work with known hosts
+- Improved error handling in download operations
+- Aligned README with current CLI behavior
+
+### Testing
+- Added comprehensive tests for Vault authentication
+- Improved test coverage overall
+
+## Installation
+
+After this release is published to PyPI, users can install or upgrade with:
+
+```bash
+pip install databusclient==0.15
+# or to upgrade
+pip install --upgrade databusclient
+```
+
+## Build Artifacts
+
+The following distribution files have been created and validated:
+- `databusclient-0.15-py3-none-any.whl` (wheel format)
+- `databusclient-0.15.tar.gz` (source distribution)
+
+Both files have passed `twine check` validation.
+
+## Publishing Instructions
+
+### Prerequisites
+1. PyPI account with maintainer access to the `databusclient` package
+2. PyPI API token configured
+
+### Steps to Publish
+
+1. **Verify the build artifacts** (already done):
+   ```bash
+   poetry build
+   twine check dist/*
+   ```
+
+2. **Upload to TestPyPI** (recommended first):
+   ```bash
+   twine upload --repository testpypi dist/*
+   ```
+   Then test installation:
+   ```bash
+   pip install --index-url https://test.pypi.org/simple/ databusclient==0.15
+   ```
+
+3. **Upload to PyPI**:
+   ```bash
+   twine upload dist/*
+   ```
+
+4. **Create a Git tag**:
+   ```bash
+   git tag -a v0.15 -m "Release version 0.15"
+   git push origin v0.15
+   ```
+
+5. **Create a GitHub Release**:
+   - Go to GitHub repository → Releases → Draft a new release
+   - Choose tag `v0.15`
+   - Release title: `databusclient 0.15`
+   - Copy content from CHANGELOG.md
+   - Attach the dist files as release assets
+
+## Verification
+
+After publishing, verify the release:
+```bash
+pip install --upgrade databusclient==0.15
+databusclient --version
+databusclient --help
+```
+
+## Notes
+- This release resolves issue #35
+- The PyPI package will now be consistent with the repository's CLI documentation
+- Version numbers 0.13 and 0.14 were intentionally skipped as requested

databusclient/__init__.py

@@ -1,8 +1,22 @@
+"""Top-level package for the databus Python client.
+
+This module exposes a small set of convenience functions and the CLI
+entrypoint so the package can be used as a library or via
+``python -m databusclient``.
+"""
+
 from databusclient import cli
 from databusclient.api.deploy import create_dataset, create_distribution, deploy
 
+__version__ = "0.15"
 __all__ = ["create_dataset", "deploy", "create_distribution"]
 
 
 def run():
+    """Start the Click CLI application.
+
+    This function is used by the ``__main__`` module and the package
+    entrypoint to invoke the command line interface.
+    """
+
     cli.app()

databusclient/__main__.py

@@ -1,3 +1,19 @@
+"""Module used for ``python -m databusclient`` execution.
+
+Runs the package's CLI application.
+"""
+
 from databusclient import cli
 
-cli.app()
+
+def main():
+	"""Invoke the CLI application.
+
+	Kept as a named function for easier testing and clarity.
+	"""
+
+	cli.app()
+
+
+if __name__ == "__main__":
+	main()

databusclient/api/delete.py

@@ -1,3 +1,10 @@
+"""Helpers for deleting Databus resources via the Databus HTTP API.
+
+This module provides utilities to delete groups, artifacts and versions on a
+Databus instance using authenticated HTTP requests. The class `DeleteQueue`
+also allows batching of deletions.
+"""
+
 import json
 from typing import List
 
@@ -16,23 +23,43 @@ class DeleteQueue:
     """
 
     def __init__(self, databus_key: str):
+        """Create a DeleteQueue bound to a given Databus API key.
+
+        Args:
+            databus_key: API key used to authenticate deletion requests.
+        """
         self.databus_key = databus_key
         self.queue: set[str] = set()
 
     def add_uri(self, databusURI: str):
+        """Add a single Databus URI to the deletion queue.
+
+        The URI will be deleted when `execute()` is called.
+        """
         self.queue.add(databusURI)
 
     def add_uris(self, databusURIs: List[str]):
+        """Add multiple Databus URIs to the deletion queue.
+
+        Args:
+            databusURIs: Iterable of full Databus URIs.
+        """
         for uri in databusURIs:
             self.queue.add(uri)
 
     def is_empty(self) -> bool:
+        """Return True if the queue is empty."""
         return len(self.queue) == 0
 
     def is_not_empty(self) -> bool:
+        """Return True if the queue contains any URIs."""
         return len(self.queue) > 0
 
     def execute(self):
+        """Execute all queued deletions.
+
+        Each queued URI will be deleted using `_delete_resource`.
+        """
         _delete_list(
             list(self.queue),
             self.databus_key,
@@ -41,16 +68,15 @@ def execute(self):
 
 
 def _confirm_delete(databusURI: str) -> str:
-    """
-    Confirm deletion of a Databus resource with the user.
+    """Confirm deletion of a Databus resource with the user.
 
-    Parameters:
-    - databusURI: The full databus URI of the resource to delete
+    Args:
+        databusURI: The full databus URI of the resource to delete.
 
     Returns:
-    - "confirm" if the user confirms deletion
-    - "skip" if the user chooses to skip deletion
-    - "cancel" if the user chooses to cancel the entire deletion process
+        "confirm" if the user confirms deletion.
+        "skip" if the user chooses to skip deletion.
+        "cancel" if the user chooses to cancel the entire deletion process.
     """
     print(f"Are you sure you want to delete: {databusURI}?")
     print(
@@ -81,18 +107,17 @@ def _delete_resource(
     force: bool = False,
     queue: DeleteQueue = None,
 ):
-    """
-    Delete a single Databus resource (version, artifact, group).
+    """Delete a single Databus resource (version, artifact, group).
 
     Equivalent to:
     curl -X DELETE "<databusURI>" -H "accept: */*" -H "X-API-KEY: <key>"
 
-    Parameters:
-    - databusURI: The full databus URI of the resource to delete
-    - databus_key: Databus API key to authenticate the deletion request
-    - dry_run: If True, do not perform the deletion but only print what would be deleted
-    - force: If True, skip confirmation prompt and proceed with deletion
-    - queue: If queue is provided, add the URI to the queue instead of deleting immediately
+    Args:
+        databusURI: The full databus URI of the resource to delete.
+        databus_key: Databus API key to authenticate the deletion request.
+        dry_run: If True, do not perform the deletion but only print what would be deleted.
+        force: If True, skip confirmation prompt and proceed with deletion.
+        queue: If queue is provided, add the URI to the queue instead of deleting immediately.
     """
 
     # Confirm the deletion request, skip the request or cancel deletion process
@@ -134,15 +159,14 @@ def _delete_list(
     force: bool = False,
     queue: DeleteQueue = None,
 ):
-    """
-    Delete a list of Databus resources.
-
-    Parameters:
-    - databusURIs: List of full databus URIs of the resources to delete
-    - databus_key: Databus API key to authenticate the deletion requests
-    - dry_run: If True, do not perform the deletion but only print what would be deleted
-    - force: If True, skip confirmation prompt and proceed with deletion
-    - queue: If queue is provided, add the URIs to the queue instead of deleting immediately
+    """Delete a list of Databus resources.
+
+    Args:
+        databusURIs: List of full databus URIs of the resources to delete.
+        databus_key: Databus API key to authenticate the deletion requests.
+        dry_run: If True, do not perform the deletion but only print what would be deleted.
+        force: If True, skip confirmation prompt and proceed with deletion.
+        queue: If queue is provided, add the URIs to the queue instead of deleting immediately.
     """
     for databusURI in databusURIs:
         _delete_resource(
@@ -157,18 +181,17 @@ def _delete_artifact(
     force: bool = False,
     queue: DeleteQueue = None,
 ):
-    """
-    Delete an artifact and all its versions.
+    """Delete an artifact and all its versions.
 
     This function first retrieves all versions of the artifact and then deletes them one by one.
     Finally, it deletes the artifact itself.
 
-    Parameters:
-    - databusURI: The full databus URI of the artifact to delete
-    - databus_key: Databus API key to authenticate the deletion requests
-    - dry_run: If True, do not perform the deletion but only print what would be deleted
-    - force: If True, skip confirmation prompt and proceed with deletion
-    - queue: If queue is provided, add the URI to the queue instead of deleting immediately
+    Args:
+        databusURI: The full databus URI of the artifact to delete.
+        databus_key: Databus API key to authenticate the deletion requests.
+        dry_run: If True, do not perform the deletion but only print what would be deleted.
+        force: If True, skip confirmation prompt and proceed with deletion.
+        queue: If queue is provided, add the URI to the queue instead of deleting immediately.
     """
     artifact_body = fetch_databus_jsonld(databusURI, databus_key)
 
@@ -204,18 +227,17 @@ def _delete_group(
     force: bool = False,
     queue: DeleteQueue = None,
 ):
-    """
-    Delete a group and all its artifacts and versions.
+    """Delete a group and all its artifacts and versions.
 
     This function first retrieves all artifacts of the group, then deletes each artifact (which in turn deletes its versions).
     Finally, it deletes the group itself.
 
-    Parameters:
-    - databusURI: The full databus URI of the group to delete
-    - databus_key: Databus API key to authenticate the deletion requests
-    - dry_run: If True, do not perform the deletion but only print what would be deleted
-    - force: If True, skip confirmation prompt and proceed with deletion
-    - queue: If queue is provided, add the URI to the queue instead of deleting immediately
+    Args:
+        databusURI: The full databus URI of the group to delete.
+        databus_key: Databus API key to authenticate the deletion requests.
+        dry_run: If True, do not perform the deletion but only print what would be deleted.
+        force: If True, skip confirmation prompt and proceed with deletion.
+        queue: If queue is provided, add the URI to the queue instead of deleting immediately.
     """
     group_body = fetch_databus_jsonld(databusURI, databus_key)
 
@@ -242,17 +264,16 @@ def _delete_group(
 
 
 def delete(databusURIs: List[str], databus_key: str, dry_run: bool, force: bool):
-    """
-    Delete a dataset from the databus.
+    """Delete a dataset from the databus.
 
     Delete a group, artifact, or version identified by the given databus URI.
     Will recursively delete all data associated with the dataset.
 
-    Parameters:
-    - databusURIs: List of full databus URIs of the resources to delete
-    - databus_key: Databus API key to authenticate the deletion requests
-    - dry_run: If True, will only print what would be deleted without performing actual deletions
-    - force: If True, skip confirmation prompt and proceed with deletion
+    Args:
+        databusURIs: List of full databus URIs of the resources to delete.
+        databus_key: Databus API key to authenticate the deletion requests.
+        dry_run: If True, will only print what would be deleted without performing actual deletions.
+        force: If True, skip confirmation prompt and proceed with deletion.
     """
 
     queue = DeleteQueue(databus_key)