Merge pull request #88 from clowder-framework/add-file-deletion

add file deletion endpoints

Author: max-zilla

CHANGELOG.md

@@ -5,13 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+- ## 3.0.5 - 2023-10-09
+
+### Added
+
+- Support for deletion of individual files.
+
 ## 3.0.4 - 2023-09-27
 
 ### Fixed
 
 - Fixed host bug on v1 file thumbnail endpoint.
-- 
-- ## 3.0.3 - 2023-08-29
+
+## 3.0.3 - 2023-08-29
 
 ### Added
 

pyclowder/api/v1/files.py

@@ -129,6 +129,22 @@ def download_metadata(connector, client, fileid, extractor=None):
     return result
 
 
+def delete(connector, client, fileid):
+    """Delete file from Clowder.
+
+    Keyword arguments:
+    connector -- connector information, used to get missing parameters and send status updates
+    client -- ClowderClient containing authentication credentials
+    fileid -- the dataset to delete
+    """
+    url = "%s/api/files/%s?key=%s" % (client.host, fileid, client.key)
+
+    result = requests.delete(url, verify=connector.ssl_verify if connector else True)
+    result.raise_for_status()
+
+    return json.loads(result.text)
+
+
 def submit_extraction(connector, client, fileid, extractorname):
     """Submit file for extraction by given extractor.
 

pyclowder/api/v2/files.py

@@ -132,6 +132,22 @@ def download_metadata(connector, client, fileid, extractor=None):
     return result
 
 
+def delete(connector, client , fileid):
+    """Delete file from Clowder.
+
+    Keyword arguments:
+    connector -- connector information, used to get missing parameters and send status updates
+    client -- ClowderClient containing authentication credentials
+    fileid -- the dataset to delete
+    """
+    headers = {"X-API-KEY": client.key}
+    url = "%s/api/v2/files/%s" % (client.host, fileid)
+
+    result = requests.delete(url, headers=headers, verify=connector.ssl_verify if connector else True)
+    result.raise_for_status()
+
+    return json.loads(result.text)
+
 def submit_extraction(connector, client, fileid, extractorname):
     """Submit file for extraction by given extractor.
 

pyclowder/files.py

@@ -98,6 +98,21 @@ def download_metadata(connector, host, key, fileid, extractor=None):
     return result.json()
 
 
+def delete(connector, host, key, fileid):
+    """Delete file from Clowder.
+
+        Keyword arguments:
+        connector -- connector information, used to get missing parameters and send status updates
+        host -- the clowder host, including http and port, should end with a /
+        key -- the secret key to login to clowder
+        fileid -- the file to delete
+        """
+    client = ClowderClient(host=host, key=key)
+    result = files.delete(connector, client, fileid)
+    result.raise_for_status()
+
+    return json.loads(result.text)
+
 def submit_extraction(connector, host, key, fileid, extractorname):
     """Submit file for extraction by given extractor.
 

setup.py

@@ -8,7 +8,7 @@
 
 setup(
     name='pyclowder',
-    version='3.0.4',
+    version='3.0.5',
     description='Python SDK for the Clowder Data Management System',
     long_description=long_description,