Skip to main content

Random Pun is a simple tool for getting random puns. It returns a random pun from a collection of puns.

Project description

Random Pun API

Random Pun is a simple tool for getting random puns. It returns a random pun from a collection of puns.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Random Pun API


Installation

Using pip:

pip install apiverve-randompun

Using pip3:

pip3 install apiverve-randompun

Configuration

Before using the randompun API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_randompun.apiClient import RandompunAPIClient

# Initialize the client with your APIVerve API key
api = RandompunAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    # Make the API call
    result = api.execute()

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Random Pun API documentation is found here: https://docs.apiverve.com/ref/randompun. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_randompun.apiClient import RandompunAPIClient

# Initialize the client with your APIVerve API key
api = RandompunAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
# This API does not require a Query
Simple Request
# Make a request to the API
result = api.execute()

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "category": "Miscellaneous",
    "rating": 3,
    "pun": "If someone with multiple personalities threatens to kill himself, is it considered a hostage situation?"
  }
}

Error Handling

The API client provides comprehensive error handling through the RandompunAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_randompun.apiClient import RandompunAPIClient, RandompunAPIClientError

api = RandompunAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()
    print("Success!")
    print(result)
except RandompunAPIClientError 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

from apiverve_randompun.apiClient import RandompunAPIClient, RandompunAPIClientError

api = RandompunAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()

    # 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 RandompunAPIClientError 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:

from apiverve_randompun.apiClient import RandompunAPIClient, RandompunAPIClientError

# This API does not require a Query

# Using context manager ensures proper cleanup
with RandompunAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute()
        print(result)
    except RandompunAPIClientError 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:

from apiverve_randompun.apiClient import RandompunAPIClient

# Enable debug mode
api = RandompunAPIClient("[YOUR_API_KEY]", debug=True)

# This API does not require a Query

# Debug information will be printed to console
result = api.execute()

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_randompun.apiClient import RandompunAPIClient

api = RandompunAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_randompun-1.1.14.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_randompun-1.1.14-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_randompun-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_randompun-1.1.14.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_randompun-1.1.14.tar.gz
Algorithm Hash digest
SHA256 1a0488290dccfaa2c5656c4cbf1cd58d72bef62d4273946dca80d05b18ab2602
MD5 ad659bfa5ea0c6e387acc30e54e72c27
BLAKE2b-256 eacc49fbfd894c0fa798a130fb21c4c3e3c5b0e3df68fd88d09f0d6dac043692

See more details on using hashes here.

File details

Details for the file apiverve_randompun-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_randompun-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5f4fbdcafe64f37d66b708afe9e15b75b400bf529a9f7bcfcd74e2a2e9f0fcd1
MD5 05f6083f5c5bd4b77dcbaa130988d583
BLAKE2b-256 4d31f7b870fd042c82049a1cc77624d5a98e34e8d43af28930747f95ef718368

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page