xpawn 0.2.2

XPawn: A Python client for the XPawn API.

XPawn Python Client

A Python client library for interacting with the XPawn API.

Installation

pip install xpawn

Quick Start

from xpawn import xpawn

# Initialize the client
client = xpawn.Client(api_key='your-api-key')

# Get a prompt by ID
response = client.get_prompt('prompt-id')
print(response)

Configuration

Timeout

You can set a custom timeout (default is 30 seconds):

client = xpawn.Client(
    api_key='your-api-key',
    timeout=60
)

API Methods

get_prompt(prompt_id)

Retrieve a prompt by its ID.

Parameters:

• prompt_id (str): The ID of the prompt to retrieve

Returns:

• dict: The prompt data from the API

Example:

response = client.get_prompt('prompt-123')

health_check()

Perform a health check on the API.

Returns:

• dict: Health check response

Example:

health = client.health_check()

Error Handling

The client raises XPawnAPIError for API-related errors:

from xpawn.client import XPawnAPIError

try:
    response = client.get_prompt('invalid-id')
except XPawnAPIError as e:
    print(f"API Error: {e}")
    print(f"Status Code: {e.status_code}")

License

MIT License