realitydefender 0.1.0__tar.gz

realitydefender-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

realitydefender-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE
+include README.md
+include requirements*.txt
+include pyproject.toml
+
+recursive-include src *.py
+recursive-include tests *.py
+recursive-include examples *.py
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]
+recursive-exclude * *.so
+recursive-exclude * .DS_Store 

realitydefender-0.1.0/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: realitydefender
+Version: 0.1.0
+Summary: SDK for the Reality Defender deepfake detection API
+Author-email: Reality Defender <support@realitydefender.com>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://github.com/Reality-Defender/eng-sdk/tree/main/python
+Project-URL: Source, https://github.com/Reality-Defender/eng-sdk
+Project-URL: Issue Tracker, https://github.com/Reality-Defender/eng-sdk/issues
+Keywords: deepfake,ai,detection,reality defender,media authentication,computer vision
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Security
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.18.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.1.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: mypy>=0.931; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: sphinx>=4.4.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# Reality Defender SDK for Python
+
+[![codecov](https://codecov.io/gh/Reality-Defender/realitydefender-sdk-python/graph/badge.svg?token=S64OCTEW6B)](https://codecov.io/gh/Reality-Defender/realitydefender-sdk-python)
+
+A Python SDK for the Reality Defender API to detect deepfakes and manipulated media.
+
+## Installation
+
+```bash
+# Using pip
+pip install realitydefender
+
+# Using poetry
+poetry add realitydefender
+```
+
+## Getting Started
+
+First, you need to obtain an API key from the [Reality Defender Platform](https://app.realitydefender.ai).
+
+### Basic Usage
+
+```python
+from realitydefender import RealityDefender
+
+# Initialize the SDK with your API key
+reality_defender = RealityDefender(
+    api_key="your-api-key",
+    # Optional: custom base URL if needed
+    # base_url="https://api.dev.realitydefender.xyz"
+)
+
+# Upload a file for analysis
+response = reality_defender.upload(file_path="/path/to/your/file.jpg")
+request_id = response["request_id"]
+
+# Callback-based approach to get results
+def on_result(result):
+    print(f"Status: {result['status']}")
+    print(f"Score: {result['score']}")
+    
+    # List model results
+    for model in result["models"]:
+        print(f"{model['name']}: {model['status']} ({model['score']})")
+
+def on_error(error):
+    print(f"Error: {error['message']} ({error['code']})")
+
+reality_defender.get_result_async(request_id, on_result, on_error)
+
+# Alternative: Poll for results synchronously
+# result = reality_defender.get_result(request_id)
+```
+
+### Synchronous Approach
+
+As an alternative to the callback-based approach, you can use synchronous polling:
+
+```python
+from realitydefender import RealityDefender
+
+# Initialize the SDK with your API key
+reality_defender = RealityDefender(
+    api_key="your-api-key"
+)
+
+def detect_media():
+    try:
+        # Upload a file for analysis
+        response = reality_defender.upload(file_path="/path/to/your/file.jpg")
+        request_id = response["request_id"]
+        
+        # Get results using the requestId (polls until completion)
+        result = reality_defender.get_result(request_id)
+        
+        # Process the results
+        print(f"Status: {result['status']}")
+        print(f"Score: {result['score']}")
+        
+        # List model results
+        for model in result["models"]:
+            print(f"{model['name']}: {model['status']} ({model['score']})")
+        
+        return result
+    except Exception as error:
+        print(f"Error: {str(error)}")
+        raise
+
+# Call the function
+try:
+    result = detect_media()
+    print("Detection completed successfully")
+except Exception:
+    print("Detection failed")
+```
+
+## Architecture
+
+The SDK is designed with a modular architecture for better maintainability and testability:
+
+- **Client**: HTTP communication with the Reality Defender API
+- **Core**: Configuration, constants, and callbacks
+- **Detection**: Media upload and results processing
+- **Models**: Data classes for API responses and SDK interfaces
+- **Utils**: File operations and helper functions
+
+## API Reference
+
+### Initialize the SDK
+
+```python
+reality_defender = RealityDefender(
+    api_key=str,               # Required: Your API key
+    base_url=str,              # Optional: Custom API base URL
+    timeout=int                # Optional: Default request timeout in seconds
+)
+```
+
+### Upload Media for Analysis
+
+```python
+response = reality_defender.upload(
+    file_path=str,             # Required: Path to the file to analyze
+    polling_interval=int,      # Optional: Interval in seconds to poll for results (default: 5)
+    timeout=int                # Optional: Timeout in seconds for polling (default: 300)
+)
+```
+
+Returns: `{"request_id": str, "media_id": str}`
+
+### Get Results for a Request
+
+```python
+result = reality_defender.get_result(request_id)
+```
+
+Returns a dictionary:
+
+```python
+{
+    "status": str,       # Overall status (e.g., "ARTIFICIAL", "AUTHENTIC", etc.)
+    "score": float,      # Overall confidence score (0-100)
+    "models": [          # Array of model-specific results
+        {
+            "name": str,     # Model name
+            "status": str,   # Model-specific status
+            "score": float   # Model-specific score
+        }
+    ]
+}
+```
+
+### Asynchronous Results
+
+```python
+reality_defender.get_result_async(
+    request_id=str,              # Required: Request ID from upload
+    on_result=callable,          # Required: Callback for results
+    on_error=callable,           # Required: Callback for errors
+    polling_interval=int,        # Optional: Polling interval in seconds
+    timeout=int                  # Optional: Timeout in seconds
+)
+```
+
+## Error Handling
+
+The SDK raises exceptions for various error scenarios:
+
+```python
+try:
+    result = reality_defender.upload(file_path="/path/to/file.jpg")
+except RealityDefenderError as error:
+    print(f"Error: {error.message} ({error.code})")
+    # Error codes: 'unauthorized', 'server_error', 'timeout', 
+    # 'invalid_file', 'upload_failed', 'not_found', 'unknown_error'
+```
+
+## Examples
+
+See the `examples` directory for more detailed usage examples.
+
+## Running Examples
+
+To run the example code in this SDK, follow these steps:
+
+```bash
+# Navigate to the python directory
+cd python
+
+# Install the package in development mode
+pip install -e .
+
+# Set your API key
+export REALITY_DEFENDER_API_KEY='<your-api-key>'
+
+# Run the example
+python examples/basic_usage.py
+```
+
+The example code demonstrates how to upload a sample image and process the detection results. 

realitydefender-0.1.0/README.md

@@ -0,0 +1,200 @@
+# Reality Defender SDK for Python
+
+[![codecov](https://codecov.io/gh/Reality-Defender/realitydefender-sdk-python/graph/badge.svg?token=S64OCTEW6B)](https://codecov.io/gh/Reality-Defender/realitydefender-sdk-python)
+
+A Python SDK for the Reality Defender API to detect deepfakes and manipulated media.
+
+## Installation
+
+```bash
+# Using pip
+pip install realitydefender
+
+# Using poetry
+poetry add realitydefender
+```
+
+## Getting Started
+
+First, you need to obtain an API key from the [Reality Defender Platform](https://app.realitydefender.ai).
+
+### Basic Usage
+
+```python
+from realitydefender import RealityDefender
+
+# Initialize the SDK with your API key
+reality_defender = RealityDefender(
+    api_key="your-api-key",
+    # Optional: custom base URL if needed
+    # base_url="https://api.dev.realitydefender.xyz"
+)
+
+# Upload a file for analysis
+response = reality_defender.upload(file_path="/path/to/your/file.jpg")
+request_id = response["request_id"]
+
+# Callback-based approach to get results
+def on_result(result):
+    print(f"Status: {result['status']}")
+    print(f"Score: {result['score']}")
+    
+    # List model results
+    for model in result["models"]:
+        print(f"{model['name']}: {model['status']} ({model['score']})")
+
+def on_error(error):
+    print(f"Error: {error['message']} ({error['code']})")
+
+reality_defender.get_result_async(request_id, on_result, on_error)
+
+# Alternative: Poll for results synchronously
+# result = reality_defender.get_result(request_id)
+```
+
+### Synchronous Approach
+
+As an alternative to the callback-based approach, you can use synchronous polling:
+
+```python
+from realitydefender import RealityDefender
+
+# Initialize the SDK with your API key
+reality_defender = RealityDefender(
+    api_key="your-api-key"
+)
+
+def detect_media():
+    try:
+        # Upload a file for analysis
+        response = reality_defender.upload(file_path="/path/to/your/file.jpg")
+        request_id = response["request_id"]
+        
+        # Get results using the requestId (polls until completion)
+        result = reality_defender.get_result(request_id)
+        
+        # Process the results
+        print(f"Status: {result['status']}")
+        print(f"Score: {result['score']}")
+        
+        # List model results
+        for model in result["models"]:
+            print(f"{model['name']}: {model['status']} ({model['score']})")
+        
+        return result
+    except Exception as error:
+        print(f"Error: {str(error)}")
+        raise
+
+# Call the function
+try:
+    result = detect_media()
+    print("Detection completed successfully")
+except Exception:
+    print("Detection failed")
+```
+
+## Architecture
+
+The SDK is designed with a modular architecture for better maintainability and testability:
+
+- **Client**: HTTP communication with the Reality Defender API
+- **Core**: Configuration, constants, and callbacks
+- **Detection**: Media upload and results processing
+- **Models**: Data classes for API responses and SDK interfaces
+- **Utils**: File operations and helper functions
+
+## API Reference
+
+### Initialize the SDK
+
+```python
+reality_defender = RealityDefender(
+    api_key=str,               # Required: Your API key
+    base_url=str,              # Optional: Custom API base URL
+    timeout=int                # Optional: Default request timeout in seconds
+)
+```
+
+### Upload Media for Analysis
+
+```python
+response = reality_defender.upload(
+    file_path=str,             # Required: Path to the file to analyze
+    polling_interval=int,      # Optional: Interval in seconds to poll for results (default: 5)
+    timeout=int                # Optional: Timeout in seconds for polling (default: 300)
+)
+```
+
+Returns: `{"request_id": str, "media_id": str}`
+
+### Get Results for a Request
+
+```python
+result = reality_defender.get_result(request_id)
+```
+
+Returns a dictionary:
+
+```python
+{
+    "status": str,       # Overall status (e.g., "ARTIFICIAL", "AUTHENTIC", etc.)
+    "score": float,      # Overall confidence score (0-100)
+    "models": [          # Array of model-specific results
+        {
+            "name": str,     # Model name
+            "status": str,   # Model-specific status
+            "score": float   # Model-specific score
+        }
+    ]
+}
+```
+
+### Asynchronous Results
+
+```python
+reality_defender.get_result_async(
+    request_id=str,              # Required: Request ID from upload
+    on_result=callable,          # Required: Callback for results
+    on_error=callable,           # Required: Callback for errors
+    polling_interval=int,        # Optional: Polling interval in seconds
+    timeout=int                  # Optional: Timeout in seconds
+)
+```
+
+## Error Handling
+
+The SDK raises exceptions for various error scenarios:
+
+```python
+try:
+    result = reality_defender.upload(file_path="/path/to/file.jpg")
+except RealityDefenderError as error:
+    print(f"Error: {error.message} ({error.code})")
+    # Error codes: 'unauthorized', 'server_error', 'timeout', 
+    # 'invalid_file', 'upload_failed', 'not_found', 'unknown_error'
+```
+
+## Examples
+
+See the `examples` directory for more detailed usage examples.
+
+## Running Examples
+
+To run the example code in this SDK, follow these steps:
+
+```bash
+# Navigate to the python directory
+cd python
+
+# Install the package in development mode
+pip install -e .
+
+# Set your API key
+export REALITY_DEFENDER_API_KEY='<your-api-key>'
+
+# Run the example
+python examples/basic_usage.py
+```
+
+The example code demonstrates how to upload a sample image and process the detection results.