deepxl-python-sdk 1.0.0__tar.gz

deepxl_python_sdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DeepXL.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

deepxl_python_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: deepxl-python-sdk
+Version: 1.0.0
+Summary: Python Software Development Kit for DeepXL AI Fraud Detection Services
+Author-email: deepxl <david@deepxl.ai>
+License-Expression: MIT
+Project-URL: Homepage, https://deepxl.ai
+Project-URL: Issues, https://github.com/deepxl/python-sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# deepxl-python-sdk
+Python Software Development Kit for DeepXL fraud detection services
+
+## Installation
+
+Install the SDK using pip
+
+```bash
+pip install deepxl-python-sdk
+```
+
+## Example
+
+To use the DeepXL client, you must first create an API key in the [dashboard](https://app.deepxl.ai/settings?tab=apiKeys). You can create a new API key in Settings -> API Keys -> Create API Key.
+
+Treat this API key like you would any environment secret. Do not commit to a public repository or store in plain text.
+
+```python
+from deepxl-python-sdk import DeepXLClient
+
+client = new DeepXLClient(MY_API_KEY)
+
+analysis_result = client.analyze_file("documents-model", ".\\file.pdf")
+```
+
+## Client methods
+
+### check_usage
+Returns the monthly usage quota and current usage for the payment period for each media type.
+
+#### Returns:
+
+Returns a ```UsageResponse``` object with the following properties:
+
+|Property|Type|
+|----|----|
+|image_usage_limit|int|
+|image_usage|int|
+|video_usage_limit|int|
+|video_usage|int|
+|audio_usage_limit|int|
+|audio_usage|int|
+|document_usage_limit|int|
+|document_usage|int|
+
+### analyze
+
+Analyze file data with DeepXL fraud detection. 
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file_name:** the name of the file to analyze
+- **file_data**: byte array of file data to analyze
+
+> Note: while you can use a constant string as file name, it is recommended you use unique identifiers to make files easier to find in analysis history.
+
+### analyze_file
+
+Analyze file with DeepXL fraud detection. This does the same thing as ```analyze``` but takes a file path as input instead of binary file data.
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file:** path of the file to analyze
+
+#### Returns
+
+Both ```analyze``` and ```analyze_file``` return an ```AnalysisResult``` object with the following properties:
+
+| Property | Type | Description |
+|----------|------|-|
+|likelihood|float|The percent likelihood that the file has been manipulated|
+|reasoning|str[]|model reasoning|
+|model_results|dict|model-specific outputs|
+
+

deepxl_python_sdk-1.0.0/README.md

@@ -0,0 +1,77 @@
+# deepxl-python-sdk
+Python Software Development Kit for DeepXL fraud detection services
+
+## Installation
+
+Install the SDK using pip
+
+```bash
+pip install deepxl-python-sdk
+```
+
+## Example
+
+To use the DeepXL client, you must first create an API key in the [dashboard](https://app.deepxl.ai/settings?tab=apiKeys). You can create a new API key in Settings -> API Keys -> Create API Key.
+
+Treat this API key like you would any environment secret. Do not commit to a public repository or store in plain text.
+
+```python
+from deepxl-python-sdk import DeepXLClient
+
+client = new DeepXLClient(MY_API_KEY)
+
+analysis_result = client.analyze_file("documents-model", ".\\file.pdf")
+```
+
+## Client methods
+
+### check_usage
+Returns the monthly usage quota and current usage for the payment period for each media type.
+
+#### Returns:
+
+Returns a ```UsageResponse``` object with the following properties:
+
+|Property|Type|
+|----|----|
+|image_usage_limit|int|
+|image_usage|int|
+|video_usage_limit|int|
+|video_usage|int|
+|audio_usage_limit|int|
+|audio_usage|int|
+|document_usage_limit|int|
+|document_usage|int|
+
+### analyze
+
+Analyze file data with DeepXL fraud detection. 
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file_name:** the name of the file to analyze
+- **file_data**: byte array of file data to analyze
+
+> Note: while you can use a constant string as file name, it is recommended you use unique identifiers to make files easier to find in analysis history.
+
+### analyze_file
+
+Analyze file with DeepXL fraud detection. This does the same thing as ```analyze``` but takes a file path as input instead of binary file data.
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file:** path of the file to analyze
+
+#### Returns
+
+Both ```analyze``` and ```analyze_file``` return an ```AnalysisResult``` object with the following properties:
+
+| Property | Type | Description |
+|----------|------|-|
+|likelihood|float|The percent likelihood that the file has been manipulated|
+|reasoning|str[]|model reasoning|
+|model_results|dict|model-specific outputs|
+
+

deepxl_python_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "deepxl-python-sdk"
+version = "1.0.0"
+authors = [
+  { name="deepxl", email="david@deepxl.ai" },
+]
+description = "Python Software Development Kit for DeepXL AI Fraud Detection Services"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[build-system]
+requires = ["setuptools >= 77"]
+build-backend = "setuptools.build_meta"
+
+[project.urls]
+Homepage = "https://deepxl.ai"
+Issues = "https://github.com/deepxl/python-sdk"

deepxl_python_sdk-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk/__init__.py

@@ -0,0 +1,9 @@
+from .client import DeepXLClient, UsageResponse, AnalysisResponse
+from .error import DeepXLError
+
+__all__ = [
+  "DeepXLClient", 
+  "UsageResponse", 
+  "AnalysisResponse",
+  "DeepXLError"
+]

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk/client.py

@@ -0,0 +1,158 @@
+import requests
+from .mimetypes import get_mimetype
+from .error import DeepXLError
+import re
+
+URL = "https://api.deepxl.ai/"
+
+
+class UsageResponse:
+  def __init__(self, image_usage_limit, image_usage, video_usage_limit, video_usage, audio_usage_limit, audio_usage, document_usage_limit, document_usage):
+    self.image_usage_limit = image_usage_limit
+    self.image_usage = image_usage
+    self.video_usage_limit = video_usage_limit
+    self.video_usage = video_usage
+    self.audio_usage_limit = audio_usage_limit
+    self.audio_usage = audio_usage
+    self.document_usage_limit = document_usage_limit
+    self.document_usage = document_usage
+  
+
+  def __str__(self):
+    return f"Image Usage: {self.image_usage} / {self.image_usage_limit}\nVideo Usage: {self.video_usage} / {self.video_usage_limit}\nAudio Usage: {self.audio_usage} / {self.audio_usage_limit}\nDocument Usage: {self.document_usage} / {self.document_usage_limit}"
+
+
+class AnalysisResponse:
+  def __init__(self, likelihood, reasoning, model_results: dict):
+    self.likelihood = likelihood
+    self.reasoning = reasoning
+    self.model_results = model_results
+
+
+  def __str__(self):
+    return f"Likelihood: {self.likelihood}\nReasoning: {self.reasoning}\nModel Results: {self.model_results}"
+  
+
+def handle_http_error(res):
+  json = res.json()
+  # print(res.status_code, json)
+  if res.status_code == 200:
+    return
+  if res.status_code == 400:
+    raise DeepXLError(json["message"] if json["message"] else "Bad request.")
+  if res.status_code == 401:
+    raise DeepXLError("Invalid API key.")
+  if res.status_code == 402:
+    raise DeepXLError(json["message"] if json["message"] else "Usage limit reached.")
+  if res.status_code == 403:
+    pass
+  if res.status_code == 404:
+    raise DeepXLError(json["message"] if json["message"] else "Invalid model.")
+  if res.status_code == 415: 
+    raise DeepXLError(json["message"] if json["message"] else "Invalid file type or file type is not compatible with the model.")
+  if res.statusCode == 500:
+    raise DeepXLError("Server error occured. Contact support or try again later.")
+  raise DeepXLError(f"An unknown error occured. Status code: {res.status_code}, Response: {json}")
+
+
+class DeepXLClient:
+  def __init__(self, api_key):
+    self.api_key = api_key
+
+
+  def check_usage(self):
+    res = requests.get(
+      URL + "v1/account/",
+      headers={ "x-api-key": self.api_key },
+      timeout=5.0
+    )
+    try:
+      if res.status_code == 200:
+        json = res.json()
+        return UsageResponse(
+          json["imageUsageLimit"],
+          json["imageUsage"],
+          json["videoUsageLimit"],
+          json["videoUsage"],
+          json["audioUsageLimit"],
+          json["audioUsage"],
+          json["documentUsageLimit"],
+          json["documentUsage"]
+        )
+      else:
+        handle_http_error(res)
+    except ConnectionError as e:
+      raise e
+
+
+  def analyze(self, model_name: str, file_name: str, file_data: bytes):
+    if (len(file_data) == 0):
+      raise DeepXLError("File data is missing or invalid.")
+    try:
+      file_type = get_mimetype(file_name)
+      res = requests.post(
+        URL + "v1/analysis",
+        headers={
+          "x-api-key": self.api_key,
+        },
+        data={
+          "model": model_name
+        },
+        files={
+          "file": (file_name, file_data, file_type)
+        },
+        timeout=5.0
+      )
+      if res.status_code == 200:
+        result = res.json()["result"]
+        return AnalysisResponse(
+          likelihood=result["likelihood"],
+          reasoning=result["reasoning"],
+          model_results=result["modelResults"]
+        )
+      else:
+        handle_http_error(res)          
+    except ConnectionError as e:
+      raise e
+    except DeepXLError as e:
+      raise e
+
+  
+  def analyze_file(self, model_name: str, file: str):
+    f = None
+    try:
+      f = open(file, "rb")
+      base_name = file.split(r"[\\/]+")[-1]
+      file_type = get_mimetype(file)
+      res = requests.post(
+        URL + "v1/analysis",
+        headers={
+          "x-api-key": self.api_key,
+        },
+        data={
+          "model": model_name
+        },
+        files={
+          "file": (base_name, f, file_type)
+        },
+        timeout=5.0
+      )
+      f.close()
+      if res.status_code == 200:
+        result = res.json()["result"]
+        return AnalysisResponse(
+          likelihood=result["likelihood"],
+          reasoning=result["reasoning"],
+          model_results=result["modelResults"]
+        )
+      else:
+        handle_http_error(res)
+    except ConnectionError as e:
+      if not f.closed:
+        f.close()
+      raise e
+    except FileNotFoundError as e:
+      raise DeepXLError(f'File "{file}" does not exist.')
+    except DeepXLError as e:
+      raise e
+  

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk/error.py

@@ -0,0 +1,5 @@
+class DeepXLError(Exception):
+
+  def __init__(self, message: str):
+    self.message = message
+    super().__init__(self.message)

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk/mimetypes.py

@@ -0,0 +1,36 @@
+
+# https://mimetype.io/all-types
+
+# This list is likely incomplete. Expand with need for more file compatibility
+
+def get_mimetype(filename: str):
+  ext = filename.split('.')[-1]
+  if (ext == 'jpg' or ext == 'jpeg'):
+    return 'image/jpeg'
+  elif ext == 'png':
+    return 'image/png'
+  elif ext == 'gif':
+    return 'image/gif'
+  elif ext == 'tif' or ext == 'tiff':
+    return 'image/tiff'
+  elif ext == 'bmp':
+    return 'image/bmp'
+  elif ext == 'mp4' or ext == 'mp4v' or ext == 'mpg4':
+    return 'video/mp4'
+  elif ext == 'avi':
+    return 'video/x-msvideo'
+  elif ext == 'wmv':
+    return 'video/x-ms-wmv'
+  elif ext == 'mpeg' or ext == 'mpg' or ext == 'mpe' or ext == 'm1v' or ext == 'm2v' or ext == 'mpa':
+    return 'video/mpeg'
+  elif ext == 'wav':
+    return 'audio/wav'
+  elif ext == 'mp3' or ext == 'mpga' or ext == 'm2a' or ext == 'm3a' or ext == 'mp2':
+    return 'audio/mpeg'
+  elif ext == 'wma':
+    return 'audio/x-ma-wma'
+  elif ext == 'wax':
+    return 'audio/x-ms-wax'
+  elif ext == 'pdf':
+    return 'application/pdf'
+  return None

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: deepxl-python-sdk
+Version: 1.0.0
+Summary: Python Software Development Kit for DeepXL AI Fraud Detection Services
+Author-email: deepxl <david@deepxl.ai>
+License-Expression: MIT
+Project-URL: Homepage, https://deepxl.ai
+Project-URL: Issues, https://github.com/deepxl/python-sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# deepxl-python-sdk
+Python Software Development Kit for DeepXL fraud detection services
+
+## Installation
+
+Install the SDK using pip
+
+```bash
+pip install deepxl-python-sdk
+```
+
+## Example
+
+To use the DeepXL client, you must first create an API key in the [dashboard](https://app.deepxl.ai/settings?tab=apiKeys). You can create a new API key in Settings -> API Keys -> Create API Key.
+
+Treat this API key like you would any environment secret. Do not commit to a public repository or store in plain text.
+
+```python
+from deepxl-python-sdk import DeepXLClient
+
+client = new DeepXLClient(MY_API_KEY)
+
+analysis_result = client.analyze_file("documents-model", ".\\file.pdf")
+```
+
+## Client methods
+
+### check_usage
+Returns the monthly usage quota and current usage for the payment period for each media type.
+
+#### Returns:
+
+Returns a ```UsageResponse``` object with the following properties:
+
+|Property|Type|
+|----|----|
+|image_usage_limit|int|
+|image_usage|int|
+|video_usage_limit|int|
+|video_usage|int|
+|audio_usage_limit|int|
+|audio_usage|int|
+|document_usage_limit|int|
+|document_usage|int|
+
+### analyze
+
+Analyze file data with DeepXL fraud detection. 
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file_name:** the name of the file to analyze
+- **file_data**: byte array of file data to analyze
+
+> Note: while you can use a constant string as file name, it is recommended you use unique identifiers to make files easier to find in analysis history.
+
+### analyze_file
+
+Analyze file with DeepXL fraud detection. This does the same thing as ```analyze``` but takes a file path as input instead of binary file data.
+
+#### Inputs
+
+- **model_name:** the name of the model to use. You can find a complete list in our docs.
+- **file:** path of the file to analyze
+
+#### Returns
+
+Both ```analyze``` and ```analyze_file``` return an ```AnalysisResult``` object with the following properties:
+
+| Property | Type | Description |
+|----------|------|-|
+|likelihood|float|The percent likelihood that the file has been manipulated|
+|reasoning|str[]|model reasoning|
+|model_results|dict|model-specific outputs|
+
+

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/deepxl_python_sdk/__init__.py
+src/deepxl_python_sdk/client.py
+src/deepxl_python_sdk/error.py
+src/deepxl_python_sdk/mimetypes.py
+src/deepxl_python_sdk.egg-info/PKG-INFO
+src/deepxl_python_sdk.egg-info/SOURCES.txt
+src/deepxl_python_sdk.egg-info/dependency_links.txt
+src/deepxl_python_sdk.egg-info/top_level.txt
+test/test_client.py

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

deepxl_python_sdk-1.0.0/src/deepxl_python_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+deepxl_python_sdk

deepxl_python_sdk-1.0.0/test/test_client.py

@@ -0,0 +1,102 @@
+from deepxl_python_sdk import DeepXLClient, UsageResponse, AnalysisResponse, DeepXLError
+import unittest
+import os
+
+
+API_KEY = os.environ['TESTING_API_KEY']
+
+
+class TestClient(unittest.TestCase):
+
+  def test_check_usage(self):
+    client = DeepXLClient(API_KEY)
+    response = client.check_usage()
+    self.assertIsInstance(response, UsageResponse)
+    self.assertTrue(response.image_usage_limit is not None)
+    self.assertTrue(response.image_usage is not None)
+    self.assertTrue(response.video_usage_limit is not None)
+    self.assertTrue(response.video_usage is not None)
+    self.assertTrue(response.audio_usage_limit is not None)
+    self.assertTrue(response.audio_usage is not None)
+    self.assertTrue(response.document_usage_limit is not None)
+    self.assertTrue(response.document_usage is not None)
+
+
+  def test_analyze(self):
+    client = DeepXLClient(API_KEY)
+    f = open(".\\test\\rickroll.jpg", 'rb')
+    data = f.read()
+    f.close()
+    response = client.analyze("always-false", "rickroll.jpg", data)
+    self.assertIsInstance(response, AnalysisResponse)
+    self.assertTrue(response.likelihood is not None)
+    self.assertTrue(response.reasoning is not None)
+    self.assertTrue(response.model_results is not None)
+
+  
+  def test_analyze_file(self):
+    client = DeepXLClient(API_KEY)
+    response = client.analyze_file("always-true", ".\\test\\rickroll.jpg")
+    print(response)
+    self.assertIsInstance(response, AnalysisResponse)
+    self.assertTrue(response.likelihood is not None)
+    self.assertTrue(response.reasoning is not None)
+    self.assertTrue(response.model_results is not None)
+
+
+  def test_unauthorized(self):
+    client = DeepXLClient("bad123")
+    try:
+      response = client.check_usage()
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, "Invalid API key.")
+
+    try:
+      response = client.analyze_file("always-true", "C:\\Users\\David\\Pictures\\rickroll.jpg")
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, "Invalid API key.")
+
+
+  def test_invalid_model_name(self):
+    client = DeepXLClient(API_KEY)
+    model_name = "not-a-model"
+    try:
+      f = open(".\\test\\rickroll.jpg", 'rb')
+      data = f.read()
+      f.close()
+      response = client.analyze(model_name, "rickroll.jpg", data)
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, f"Invalid model: {model_name}")
+
+    try:
+      response = client.analyze_file(model_name, ".\\test\\rickroll.jpg")
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, f"Invalid model: {model_name}")
+
+
+  def test_no_file_data(self):
+    client = DeepXLClient(API_KEY)
+    try:
+      response = client.analyze("always-true", "rickroll.jpg", b"")
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, "File data is missing or invalid.")
+
+
+  def test_file_not_found(self):
+    client = DeepXLClient(API_KEY)
+    file = ".\\file\\not\\here.png"
+    try:
+      response = client.analyze_file("always-true", file)
+    except Exception as e:
+      self.assertIsInstance(e, DeepXLError)
+      self.assertEqual(e.message, f'File "{file}" does not exist.')
+
+
+if __name__ == '__main__':
+  unittest.main()
+