Merge pull request #5 from imagekit-developer/fixing

chore: add func alias

Author: kernelshard

README.md

@@ -244,7 +244,7 @@ specify tags for a file at the time of upload use the tags parameter as specifie
 Simple usage
 
 ```python
-imagekit.upload(
+imagekit.file_upload(
     file = "<url|base_64|binary>", # required
     file_name= "my_file_name.jpg"  # required
 )
@@ -453,15 +453,15 @@ imagekit.get_file_details(file_id)
 **3. Get File Metadata**
 Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files)
 ```python
-imagekit.get_metadata(file_id)
+imagekit.get_file_metadata(file_id)
 ```
 
 
 **3. Get File Metadata from remote url**
 Accepts the remote file url and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-from-remote-url)
 
 ```python
-imagekit.get_remote_url_metadata(remote_file_url)
+imagekit.get_remote_file_url_metadata(remote_file_url)
 ```
 
 **4. Update File Details**
@@ -489,22 +489,22 @@ Delete a file as per the [API documentation here](https://docs.imagekit.io/api-r
 deleted.
 
 ```python
-imagekit.bulk_delete(["file_id1", "file_id2"])
+imagekit.bulk_file_delete(["file_id1", "file_id2"])
 ```
 
 **6. Purge Cache**
 Programmatically issue a cache clear request as clear request as pet the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache).
 Accepts the full URL of the file for which the cache has to be cleared.
 ```python
-imagekit.purge_cache(full_url)
+imagekit.purge_file_cache(full_url)
 ```
 **7. Purge Cache Status**
 
 Get the purge cache request status using the request ID returned when a purge cache request gets submitted as pet the
 [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache-status)
 
 ```python
-imagekit.get_purge_cache_status(cache_request_id)
+imagekit.get_purge_file_cache_status(cache_request_id)
 ```
 
 

imagekitio/client.py

@@ -32,6 +32,11 @@ def upload(self, file=None, file_name=None, options=None) -> Dict[str, Any]:
         """
         return self.file.upload(file, file_name, options)
 
+    def upload_file(self, file=None, file_name=None, options=None) -> Dict[str, Any]:
+        """Provides upload functionality
+        """
+        return self.file.upload(file, file_name, options)
+
     def list_files(self, options: Dict) -> Dict:
         """Get list(filtered if given param) of images of client
         """
@@ -57,24 +62,47 @@ def bulk_delete(self, file_ids: list = None):
         """
         return self.file.batch_delete(file_ids)
 
+    def bulk_file_delete(self, file_ids: list = None):
+        """Delete files in bulk by provided list of ids
+        """
+        return self.file.batch_delete(file_ids)
+
     def purge_cache(self, file_url: str = None) -> Dict[str, Any]:
         """Purge Cache from server by file url
         """
         return self.file.purge_cache(file_url)
 
+    def purge_file_cache(self, file_url: str = None) -> Dict[str, Any]:
+        """Purge Cache from server by file url
+        """
+        return self.file.purge_cache(file_url)
+
     def get_purge_cache_status(self, purge_cache_id: str = "") -> Dict[str, Any]:
         """Get Purge Cache status by purge cache request_id
         """
         return self.file.get_purge_cache_status(str(purge_cache_id))
 
+    def get_purge_file_cache_status(self, purge_cache_id: str = "") -> Dict[str, Any]:
+        """Get Purge Cache status by purge cache request_id
+        """
+        return self.file.get_purge_cache_status(str(purge_cache_id))
+
     def get_metadata(self, file_id: str = None) -> Dict[str, Any]:
         """Get Meta Data of a file by file id
         """
         return self.file.get_metadata(str(file_id))
 
+    def get_file_metadata(self, file_id: str = None) -> Dict[str, Any]:
+        """Get Meta Data of a file by file id
+        """
+        return self.file.get_metadata(str(file_id))
+
     def get_remote_url_metadata(self, remote_file_url: str = ""):
         return self.file.get_metadata_from_remote_url(remote_file_url)
 
+    def get_remote_file_url_metadata(self, remote_file_url: str = ""):
+        return self.file.get_metadata_from_remote_url(remote_file_url)
+
     def url(self, options: Dict[str, Any]) -> str:
         """Get generated Url from options parameter
         """

sample/sample.py

@@ -36,7 +36,7 @@
     # 2 Using full image URL
     image_url = imagekit.url(
         {
-            "src": "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg",
+            "src": url_endpoint.rstrip("/") + "/default-image.jpg",
             "transformation": [{"height": "300", "width": "400"}],
         }
     )
@@ -97,7 +97,7 @@
     ]
     print("List files-", "\n", list_files)
 
-    upload = imagekit.upload(
+    upload = imagekit.upload_file(
         file=open("sample.jpg", "rb"),
         file_name="testing",
         options={
@@ -111,7 +111,7 @@
     print("Upload with binary-", upload, end="\n\n")
     file_id = upload["response"]["fileId"]
 
-    upload = imagekit.upload(
+    upload = imagekit.upload_file(
         file=url,
         file_name="testing",
         options={
@@ -126,7 +126,7 @@
     with open("sample.jpg", mode="rb") as img:
         imgstr = base64.b64encode(img.read())
 
-    upload_base64 = imagekit.upload(
+    upload_base64 = imagekit.upload_file(
         file=imgstr,
         file_name="test64",
         options={
@@ -159,19 +159,19 @@
     print("File detail with url upload-", details, end="\n\n")
 
     print("-------------------------------------")
-    file_metadata = imagekit.get_metadata(list_files["response"][0]['fileId'])
+    file_metadata = imagekit.get_file_metadata(list_files["response"][0]['fileId'])
 
     print("-------------------------------------")
     delete = imagekit.delete_file(list_files["response"][1]["fileId"], )
 
     print("Delete File-", delete)
 
     print("-------------------------------------")
-    purge_cache = imagekit.purge_cache(file_url=image_url)
+    purge_cache = imagekit.purge_file_cache(file_url=image_url)
     print("Purge cache-", purge_cache)
 
     request_id = purge_cache["response"]["request_id"]
-    purge_cache_status = imagekit.get_purge_cache_status(request_id)
+    purge_cache_status = imagekit.get_purge_file_cache_status(request_id)
 
     print("-------------------------------------")
 
@@ -190,9 +190,9 @@
 
     print("-------------------------------------")
 
-    print("Bulk File delete-", imagekit.bulk_delete(bulk_ids))
+    print("Bulk File delete-", imagekit.bulk_file_delete(bulk_ids))
 
     print("-----------------------------")
 
     remote_file_url = upload["response"]["url"]
-    print("Get metadata-", imagekit.get_remote_url_metadata(remote_file_url))
+    print("Get metadata-", imagekit.get_remote_file_url_metadata(remote_file_url))