apiverve-cryptogramgenerator 1.2.2__py3-none-any.whl

apiverve_cryptogramgenerator/__init__.py

@@ -0,0 +1,3 @@
+from .apiClient import CryptogramAPIClient, CryptogramAPIClientError
+
+__all__ = ['CryptogramAPIClient', 'CryptogramAPIClientError']

apiverve_cryptogramgenerator/apiClient.py

@@ -0,0 +1,253 @@
+import re
+from typing import Dict, Optional, Any, List
+from dataclasses import dataclass
+import requests
+
+
+class CryptogramAPIClientError(Exception):
+    """Custom exception for API client errors"""
+    def __init__(self, message: str, status_code: Optional[int] = None, response: Optional[Dict] = None):
+        self.message = message
+        self.status_code = status_code
+        self.response = response
+        super().__init__(self.message)
+
+
+class ValidationError(CryptogramAPIClientError):
+    """Custom exception for parameter validation errors"""
+    def __init__(self, errors: List[str]):
+        self.errors = errors
+        message = f"Validation failed: {' '.join(errors)}"
+        super().__init__(message)
+
+
+class CryptogramAPIClient:
+    # Validation rules for parameters (generated from schema)
+    VALIDATION_RULES = {
+        "text": {"type": "string", "required": False, "maxLength": 500},
+        "random": {"type": "boolean", "required": False, "default": False},
+        "image": {"type": "boolean", "required": False, "default": False},
+        "solutionImage": {"type": "boolean", "required": False, "default": False}
+    }
+
+    # Format validation patterns
+    FORMAT_PATTERNS = {
+        'email': r'^[^\s@]+@[^\s@]+\.[^\s@]+$',
+        'url': r'^https?://.+',
+        'ip': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$',
+        'date': r'^\d{4}-\d{2}-\d{2}$',
+        'hexColor': r'^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$'
+    }
+
+    def __init__(self, api_key: str, secure: bool = True, debug: bool = False):
+        """
+        Initialize the CryptogramAPIClient with the API key and optional settings
+
+        :param api_key: Your APIVerve API key
+        :param secure: Deprecated. Always set to True
+        :param debug: Enable debug logging (default: False)
+        :raises CryptogramAPIClientError: If API key is invalid
+        """
+
+        self._validate_api_key(api_key)
+
+        self.api_key = api_key
+        self.secure = secure
+        self.debug = debug
+        self.base_url = 'https://api.apiverve.com/v1/cryptogram'
+        self.headers = {
+            'x-api-key': self.api_key,
+            'auth-mode': 'pypi-package'
+        }
+
+        # Create a session for connection pooling
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
+
+    def _validate_api_key(self, api_key: str) -> None:
+        """
+        Validate the API key format
+
+        :param api_key: API key to validate
+        :raises CryptogramAPIClientError: If API key is invalid
+        """
+        if not api_key or not api_key.strip():
+            raise CryptogramAPIClientError(
+                "API key is required. Get your API key at: https://apiverve.com"
+            )
+
+        # Check format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        if not re.match(r'^[a-zA-Z0-9_-]+$', api_key):
+            raise CryptogramAPIClientError(
+                "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores. "
+                "Get your API key at: https://apiverve.com"
+            )
+
+    def _log(self, message: str) -> None:
+        """
+        Log a debug message if debug mode is enabled
+
+        :param message: Message to log
+        """
+        if self.debug:
+            print(f"[CryptogramAPIClient DEBUG] {message}")
+
+    def _validate_params(self, params: Optional[Dict[str, Any]]) -> None:
+        """
+        Validate parameters against schema rules
+
+        :param params: Parameters to validate
+        :raises ValidationError: If validation fails
+        """
+        if not self.VALIDATION_RULES:
+            return
+
+        errors = []
+        params = params or {}
+
+        for param_name, rules in self.VALIDATION_RULES.items():
+            value = params.get(param_name)
+
+            # Check required
+            if rules.get('required') and (value is None or value == ''):
+                errors.append(f"Required parameter [{param_name}] is missing.")
+                continue
+
+            # Skip validation if value is not provided and not required
+            if value is None:
+                continue
+
+            param_type = rules.get('type', 'string')
+
+            # Type validation
+            if param_type in ('integer', 'number'):
+                try:
+                    num_value = float(value) if param_type == 'number' else int(value)
+
+                    # Min/max validation
+                    if 'min' in rules and num_value < rules['min']:
+                        errors.append(f"Parameter [{param_name}] must be at least {rules['min']}.")
+                    if 'max' in rules and num_value > rules['max']:
+                        errors.append(f"Parameter [{param_name}] must be at most {rules['max']}.")
+                except (ValueError, TypeError):
+                    errors.append(f"Parameter [{param_name}] must be a valid {param_type}.")
+                    continue
+
+            elif param_type == 'string':
+                if not isinstance(value, str):
+                    errors.append(f"Parameter [{param_name}] must be a string.")
+                    continue
+
+                # Length validation
+                if 'minLength' in rules and len(value) < rules['minLength']:
+                    errors.append(f"Parameter [{param_name}] must be at least {rules['minLength']} characters.")
+                if 'maxLength' in rules and len(value) > rules['maxLength']:
+                    errors.append(f"Parameter [{param_name}] must be at most {rules['maxLength']} characters.")
+
+                # Format validation
+                if 'format' in rules and rules['format'] in self.FORMAT_PATTERNS:
+                    pattern = self.FORMAT_PATTERNS[rules['format']]
+                    if not re.match(pattern, value, re.IGNORECASE):
+                        errors.append(f"Parameter [{param_name}] must be a valid {rules['format']}.")
+
+            elif param_type == 'boolean':
+                if not isinstance(value, bool) and value not in ('true', 'false', True, False):
+                    errors.append(f"Parameter [{param_name}] must be a boolean.")
+
+            elif param_type == 'array':
+                if not isinstance(value, list):
+                    errors.append(f"Parameter [{param_name}] must be an array.")
+
+            # Enum validation
+            if 'enum' in rules and value not in rules['enum']:
+                errors.append(f"Parameter [{param_name}] must be one of: {', '.join(map(str, rules['enum']))}.")
+
+        if errors:
+            raise ValidationError(errors)
+
+    def execute(self, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:  # Returns CryptogramGeneratorData in 'data' field
+        """
+        Execute the API request
+
+        :param params: API parameters (optional)
+        :return: API response as a dictionary
+        :raises CryptogramAPIClientError: If the request fails or returns an error
+        :raises ValidationError: If parameter validation fails
+        """
+
+        # Validate parameters against schema rules
+        self._validate_params(params)
+
+        method = "GET"
+
+        self._log(f"Making {method} request to {self.base_url}")
+        if params:
+            self._log(f"Parameters: {params}")
+
+        try:
+            if method.upper() == 'POST':
+                self._log("Sending POST request with JSON body")
+                response = self.session.post(self.base_url, json=params, timeout=30)
+            else:
+                self._log("Sending GET request with query parameters")
+                response = self.session.get(self.base_url, params=params, timeout=30)
+
+            self._log(f"Response status code: {response.status_code}")
+
+            # Try to parse JSON response
+            try:
+                response_data = response.json()
+            except ValueError as e:
+                raise CryptogramAPIClientError(
+                    f"Invalid JSON response from API: {str(e)}",
+                    status_code=response.status_code
+                )
+
+            # Check for API-level errors in the response
+            if response_data.get('status') == 'error':
+                error_message = response_data.get('error', 'Unknown API error')
+                self._log(f"API returned error: {error_message}")
+                raise CryptogramAPIClientError(
+                    error_message,
+                    status_code=response.status_code,
+                    response=response_data
+                )
+
+            # Check HTTP status code
+            if not response.ok:
+                error_message = response_data.get('error', f"HTTP {response.status_code} error")
+                self._log(f"HTTP error: {error_message}")
+                raise CryptogramAPIClientError(
+                    error_message,
+                    status_code=response.status_code,
+                    response=response_data
+                )
+
+            self._log("Request successful")
+            return response_data
+
+        except requests.exceptions.Timeout as e:
+            self._log(f"Request timeout: {str(e)}")
+            raise CryptogramAPIClientError(f"Request timeout: {str(e)}")
+        except requests.exceptions.ConnectionError as e:
+            self._log(f"Connection error: {str(e)}")
+            raise CryptogramAPIClientError(f"Connection error: {str(e)}")
+        except requests.exceptions.RequestException as e:
+            self._log(f"Request exception: {str(e)}")
+            raise CryptogramAPIClientError(f"Request failed: {str(e)}")
+
+
+    def close(self) -> None:
+        """
+        Close the session and release resources
+        """
+        self._log("Closing session")
+        self.session.close()
+
+    def __enter__(self):
+        """Context manager entry"""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Context manager exit"""
+        self.close()

apiverve_cryptogramgenerator/exceptions.py

@@ -0,0 +1,3 @@
+class CryptogramCryptogramGeneratorAPIError(Exception):
+    """A custom exception for API errors"""
+    pass

apiverve_cryptogramgenerator/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+import os
+lib_folder = os.path.dirname(os.path.realpath(__file__))
+requirements_file = os.path.join(lib_folder, 'requirements.txt')
+install_requires = ["requests >= 2.25.1", "setuptools >= 56.0.0"]
+if os.path.exists(requirements_file):
+    with open(requirements_file, 'r') as f:
+        install_requires = f.read().splitlines()
+
+setup(
+    name='apiverve_cryptogramgenerator',
+    version='1.2.2',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=install_requires,
+    description='Cryptogram Generator creates letter substitution cipher puzzles where each letter is replaced with another letter consistently throughout the text.',
+    author='APIVerve',
+    author_email='hello@apiverve.com',
+    url='https://apiverve.com/marketplace/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=homepage',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

apiverve_cryptogramgenerator/setup_dep.py

@@ -0,0 +1,21 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='apiverve_cryptogramgenerator',
+    version='1.2.2',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        'requests',
+        'setuptools'
+    ],
+    description='Cryptogram Generator creates letter substitution cipher puzzles where each letter is replaced with another letter consistently throughout the text.',
+    author='APIVerve',
+    author_email='hello@apiverve.com',
+    url='https://apiverve.com/marketplace/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=homepage',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

apiverve_cryptogramgenerator/tests/__init__.py

@@ -0,0 +1 @@
+# Initialize test module

apiverve_cryptogramgenerator/tests/test_api.py

@@ -0,0 +1,19 @@
+import unittest
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient
+
+class TestClient(unittest.TestCase):
+
+    def setUp(self):
+        self.api_key = 'test_api_key'
+        self.client = CryptogramAPIClient(self.api_key)
+
+    def test_get(self):
+        # Assuming there's an endpoint 'test_endpoint' for testing purposes
+        try:
+            response = self.client.get('test_endpoint')
+            self.assertIsInstance(response, dict)
+        except Exception as e:
+            self.fail(f"GET request failed with exception {e}")
+
+if __name__ == '__main__':
+    unittest.main()

apiverve_cryptogramgenerator-1.2.2.dist-info/METADATA

@@ -0,0 +1,359 @@
+Metadata-Version: 2.4
+Name: apiverve-cryptogramgenerator
+Version: 1.2.2
+Summary: Cryptogram Generator creates letter substitution cipher puzzles where each letter is replaced with another letter consistently throughout the text.
+Author-email: APIVerve <hello@apiverve.com>
+License: MIT
+Project-URL: Homepage, https://apiverve.com/marketplace/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=homepage
+Project-URL: Documentation, https://docs.apiverve.com/ref/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=docs
+Project-URL: Repository, https://github.com/apiverve/cryptogram-api
+Project-URL: Twitter, https://twitter.com/apivervehq
+Keywords: cryptogram,cipher,code puzzle,substitution cipher,decode
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: English
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+Cryptogram Generator API
+============
+
+Cryptogram Generator creates letter substitution cipher puzzles where each letter is replaced with another letter consistently throughout the text.
+
+
+[![PyPI version](https://img.shields.io/pypi/v/apiverve-cryptogramgenerator.svg)](https://pypi.org/project/apiverve-cryptogramgenerator/)
+
+This is a Python wrapper for the [Cryptogram Generator API](https://apiverve.com/marketplace/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using `pip`:
+
+```bash
+pip install apiverve-cryptogramgenerator
+```
+
+Using `pip3`:
+
+```bash
+pip3 install apiverve-cryptogramgenerator
+```
+
+---
+
+## Configuration
+
+Before using the Cryptogram Generator API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+Here's a simple example to get you started quickly:
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CryptogramAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+try:
+    # Make the API call
+    result = api.execute(query)
+
+    # Print the result
+    print(result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+---
+
+## Usage
+
+The Cryptogram Generator API documentation is found here: [https://docs.apiverve.com/ref/cryptogram](https://docs.apiverve.com/ref/cryptogram?utm_source=pypi&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```python
+# Import the client module
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CryptogramAPIClient("[YOUR_API_KEY]")
+```
+
+---
+
+## Perform Request
+
+Using the API client, you can perform requests to the API.
+
+###### Define Query
+
+```python
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+```
+
+###### Simple Request
+
+```python
+# Make a request to the API
+result = api.execute(query)
+
+# Print the result
+print(result)
+```
+
+###### Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "encoded": "PNR MJSXQRV JI K PNJSGKQC DBFRG ARWBQG ZBPN K GBQWFR GPRY",
+    "original": "The journey of a thousand miles begins with a single step",
+    "cipher": {
+      "A": "K",
+      "B": "A",
+      "C": "H",
+      "D": "C",
+      "E": "R",
+      "F": "I",
+      "G": "W",
+      "H": "N",
+      "I": "B",
+      "J": "M",
+      "K": "E",
+      "L": "F",
+      "M": "D",
+      "N": "Q",
+      "O": "J",
+      "P": "Y",
+      "Q": "T",
+      "R": "X",
+      "S": "G",
+      "T": "P",
+      "U": "S",
+      "V": "L",
+      "W": "Z",
+      "X": "O",
+      "Y": "V",
+      "Z": "U"
+    },
+    "letterCount": 47,
+    "wordCount": 11,
+    "html": "<html><head><title>Cryptogram Puzzle</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 800px; margin: 0 auto;}h1 {text-align: center;}.puzzle {font-family: monospace; font-size: 24px; letter-spacing: 3px; line-height: 2.5; word-wrap: break-word;}.letter-box {display: inline-block; text-align: center; margin: 2px;}.encoded {border-bottom: 2px solid #333; min-width: 20px; display: block;}.answer {color: #ccc; font-size: 14px;}.space {width: 15px; display: inline-block;}.hint {margin-top: 30px; padding: 15px; background: #f5f5f5; border-radius: 5px;}.hint h3 {margin-top: 0;}</style></head><body><h1>Cryptogram</h1><div class='puzzle'><span class='letter-box'><span class='encoded'>P</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>N</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>M</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>J</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>S</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>X</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>Q</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>V</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>J</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>I</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>K</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>P</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>N</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>J</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>S</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>G</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>K</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>Q</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>C</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>D</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>B</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>F</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>G</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>A</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>W</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>B</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>Q</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>G</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>Z</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>B</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>P</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>N</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>K</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>G</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>B</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>Q</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>W</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>F</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='space'></span><span class='letter-box'><span class='encoded'>G</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>P</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>R</span><span class='answer'>_</span></span><span class='letter-box'><span class='encoded'>Y</span><span class='answer'>_</span></span></div><div class='hint'><h3>Letter Frequency:</h3><p>R=6, G=5, P=4, Q=4, B=4, N=3, J=3, K=3, S=2, F=2, W=2, M=1, X=1, V=1, I=1, C=1, D=1, A=1, Z=1, Y=1</p></div></body></html>",
+    "image": {
+      "imageName": "0afa5de4-52fb-4902-8139-c177c08ac98b_puzzle.png",
+      "format": ".png",
+      "downloadURL": "https://storage.googleapis.com/apiverve/APIData/cryptogram/0afa5de4-52fb-4902-8139-c177c08ac98b_puzzle.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010132&Signature=guv7GNCup4lJXTI0iCF7Bo2Cz02Wl6h2HWC0YxJ0jtzb7w%2BlW80b1OzBlGR%2BneFxFdzQPwfIuMQlaHsW0KFqPh5ITsFkSt802OEUFyxuiDn71y4XkiJx8zVDhrxNH9R9i1befMM16c%2F4WQGpgzkaaXw8TJJUT2q2s8c8ESo41K85iYcHJZ%2BGUxXeMeFDJ%2FG38pq5txarX%2F0rnmdTk0Jk%2BhEox9PXFPCzaSvWbDFYDVABIt97N2NQyqlDPRcucrm5uuE5Jb9qjT80JqzlumfqiaR3DpgPDwZkWeVyuYW4b4TZCCbbEpK%2FIlRRUZTw9gYdxDpk0B35NKN9WKSCi%2BfFWQ%3D%3D",
+      "expires": 1766010132300
+    },
+    "solutionImage": {
+      "imageName": "41e6b5b7-d98c-4d4d-8b44-f56bdb5160b9_solution.png",
+      "format": ".png",
+      "downloadURL": "https://storage.googleapis.com/apiverve/APIData/cryptogram/41e6b5b7-d98c-4d4d-8b44-f56bdb5160b9_solution.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010132&Signature=YKDpJF9MYlmXjASdgVUgtPCq8%2Fp59Eci6DIAbXuHzv9B4rALSZwyq1sMj9KoIRhryYCdNW1KGBRpcgJFSFgaEGfcNC1MNsryoV%2F7bp3TSr1%2BknwqAGQu7sWvZrtozB2oJ3Wzaqz%2BGjm74rhrOaqAx0w7%2BmJtimslEHCl8emRuZxmAhW9l8Wi%2Fv%2BsCmb7%2Bl5hj0njHSs6AWo3YtoZpWoNv7F49g1dQczrfj%2BFYW7bOoFMfcmysTz%2ByNpXECZFbvWJ3A2f0fql7itGLGK%2B%2BNlI6Q6WkQ1ye3c7skHB3DqT%2BWHLbJCm0vjbIVhIgq3Vo39ZADdogcd7uiklvEBriMFkwA%3D%3D",
+      "expires": 1766010132645
+    }
+  }
+}
+```
+
+---
+
+## Error Handling
+
+The API client provides comprehensive error handling through the `CryptogramAPIClientError` exception. Here are some examples:
+
+### Basic Error Handling
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient, CryptogramAPIClientError
+
+api = CryptogramAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+try:
+    result = api.execute(query)
+    print("Success!")
+    print(result)
+except CryptogramAPIClientError as e:
+    print(f"API Error: {e.message}")
+    if e.status_code:
+        print(f"Status Code: {e.status_code}")
+    if e.response:
+        print(f"Response: {e.response}")
+```
+
+### Handling Specific Error Types
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient, CryptogramAPIClientError
+
+api = CryptogramAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+try:
+    result = api.execute(query)
+
+    # Check for successful response
+    if result.get('status') == 'success':
+        print("Request successful!")
+        print(result.get('data'))
+    else:
+        print(f"API returned an error: {result.get('error')}")
+
+except CryptogramAPIClientError as e:
+    # Handle API client errors
+    if e.status_code == 401:
+        print("Unauthorized: Invalid API key")
+    elif e.status_code == 429:
+        print("Rate limit exceeded")
+    elif e.status_code >= 500:
+        print("Server error - please try again later")
+    else:
+        print(f"API error: {e.message}")
+except Exception as e:
+    # Handle unexpected errors
+    print(f"Unexpected error: {str(e)}")
+```
+
+### Using Context Manager (Recommended)
+
+The client supports the context manager protocol for automatic resource cleanup:
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient, CryptogramAPIClientError
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+# Using context manager ensures proper cleanup
+with CryptogramAPIClient("[YOUR_API_KEY]") as api:
+    try:
+        result = api.execute(query)
+        print(result)
+    except CryptogramAPIClientError as e:
+        print(f"Error: {e.message}")
+# Session is automatically closed here
+```
+
+---
+
+## Advanced Features
+
+### Debug Mode
+
+Enable debug logging to see detailed request and response information:
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient
+
+# Enable debug mode
+api = CryptogramAPIClient("[YOUR_API_KEY]", debug=True)
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+# Debug information will be printed to console
+result = api.execute(query)
+```
+
+### Manual Session Management
+
+If you need to manually manage the session lifecycle:
+
+```python
+from apiverve_cryptogramgenerator.apiClient import CryptogramAPIClient
+
+api = CryptogramAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "text": "The quick brown fox",
+    "random": true,
+    "image": true,
+    "solutionImage": true
+}
+
+try:
+    result = api.execute(query)
+    print(result)
+finally:
+    # Manually close the session when done
+    api.close()
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
+
+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.

apiverve_cryptogramgenerator-1.2.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+apiverve_cryptogramgenerator/__init__.py,sha256=g7b-lMRM-h1Q_sB3lxUQoH60KQYIFQO-q04dPMBQ0uA,131
+apiverve_cryptogramgenerator/apiClient.py,sha256=e3YqzcSTZd5o2YyG-VXQswnRaFJMnPhe_uwetKNkzkc,9966
+apiverve_cryptogramgenerator/exceptions.py,sha256=1KdTEqihpsVO-9B-MEeVWeSqUejbGcRWrHOnUuMAcSA,109
+apiverve_cryptogramgenerator/setup.py,sha256=LSYyUXTe4evCzsWDbRWIrfGLpPPC7SGiFamppzZMxHw,1033
+apiverve_cryptogramgenerator/setup_dep.py,sha256=3tjH8KO6tO6y3LqpOrj_zg0QI69FEvyVIzXpPOvrSZc,736
+apiverve_cryptogramgenerator/tests/__init__.py,sha256=5_6uOnBkgWAawI5-lr0N2cZ_UVvIGJ7NCh4XT5KF47o,25
+apiverve_cryptogramgenerator/tests/test_api.py,sha256=jdhi1rnCl85MNRAj-Qxv0NlDR4OrxilvPut3fuRYFZk,604
+apiverve_cryptogramgenerator-1.2.2.dist-info/licenses/LICENSE,sha256=V5x7AJRnWqzyPdD_hz1UOO2zYKZGOdRWdXElPTdwxwE,1092
+apiverve_cryptogramgenerator-1.2.2.dist-info/METADATA,sha256=zKy2ynZReIgWg8k6dlEgRQfw7XljPSQPkxst755qwCc,16089
+apiverve_cryptogramgenerator-1.2.2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+apiverve_cryptogramgenerator-1.2.2.dist-info/top_level.txt,sha256=mnZAZvUU3711wk4S6ZjPZW0pRkWL48-tJ3Yjb_ulxfI,29
+apiverve_cryptogramgenerator-1.2.2.dist-info/RECORD,,

apiverve_cryptogramgenerator-1.2.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

apiverve_cryptogramgenerator-1.2.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+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.

apiverve_cryptogramgenerator-1.2.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+apiverve_cryptogramgenerator