Card Deck Shuffler is a tool for shuffling standard playing card decks. It supports multiple decks, optional jokers, and different shuffling methods to generate randomized card sequences for games and simulations.

Project description

Card Deck Shuffler API

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Card Deck Shuffler API

Installation

Using pip:

pip install apiverve-carddeckshuffler

Using pip3:

pip3 install apiverve-carddeckshuffler

Configuration

Before using the carddeckshuffler 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_carddeckshuffler.apiClient import CarddeckshufflerAPIClient

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

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

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

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

Usage

The Card Deck Shuffler API documentation is found here: https://docs.apiverve.com/ref/carddeckshuffler. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_carddeckshuffler.apiClient import CarddeckshufflerAPIClient

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

Perform Request

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

Define Query

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

Simple Request

# Make a request to the API
result = api.execute(query)

# Print the result
print(result)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "total_cards": 52,
    "decks_used": 1,
    "includes_jokers": false,
    "shuffle_method": "fisher-yates",
    "cards": [
      {
        "rank": "3",
        "suit": "Hearts",
        "card": "3 of Hearts",
        "short": "3♥"
      },
      {
        "rank": "Ace",
        "suit": "Hearts",
        "card": "Ace of Hearts",
        "short": "A♥"
      },
      {
        "rank": "4",
        "suit": "Hearts",
        "card": "4 of Hearts",
        "short": "4♥"
      },
      {
        "rank": "Queen",
        "suit": "Spades",
        "card": "Queen of Spades",
        "short": "Q♠"
      },
      {
        "rank": "4",
        "suit": "Diamonds",
        "card": "4 of Diamonds",
        "short": "4♦"
      },
      {
        "rank": "7",
        "suit": "Hearts",
        "card": "7 of Hearts",
        "short": "7♥"
      },
      {
        "rank": "9",
        "suit": "Spades",
        "card": "9 of Spades",
        "short": "9♠"
      },
      {
        "rank": "10",
        "suit": "Hearts",
        "card": "10 of Hearts",
        "short": "10♥"
      },
      {
        "rank": "4",
        "suit": "Clubs",
        "card": "4 of Clubs",
        "short": "4♣"
      },
      {
        "rank": "2",
        "suit": "Diamonds",
        "card": "2 of Diamonds",
        "short": "2♦"
      },
      {
        "rank": "2",
        "suit": "Hearts",
        "card": "2 of Hearts",
        "short": "2♥"
      },
      {
        "rank": "Ace",
        "suit": "Diamonds",
        "card": "Ace of Diamonds",
        "short": "A♦"
      },
      {
        "rank": "Ace",
        "suit": "Spades",
        "card": "Ace of Spades",
        "short": "A♠"
      },
      {
        "rank": "Queen",
        "suit": "Clubs",
        "card": "Queen of Clubs",
        "short": "Q♣"
      },
      {
        "rank": "Jack",
        "suit": "Hearts",
        "card": "Jack of Hearts",
        "short": "J♥"
      },
      {
        "rank": "Jack",
        "suit": "Diamonds",
        "card": "Jack of Diamonds",
        "short": "J♦"
      },
      {
        "rank": "4",
        "suit": "Spades",
        "card": "4 of Spades",
        "short": "4♠"
      },
      {
        "rank": "2",
        "suit": "Spades",
        "card": "2 of Spades",
        "short": "2♠"
      },
      {
        "rank": "King",
        "suit": "Spades",
        "card": "King of Spades",
        "short": "K♠"
      },
      {
        "rank": "Queen",
        "suit": "Hearts",
        "card": "Queen of Hearts",
        "short": "Q♥"
      },
      {
        "rank": "Jack",
        "suit": "Spades",
        "card": "Jack of Spades",
        "short": "J♠"
      },
      {
        "rank": "6",
        "suit": "Clubs",
        "card": "6 of Clubs",
        "short": "6♣"
      },
      {
        "rank": "8",
        "suit": "Hearts",
        "card": "8 of Hearts",
        "short": "8♥"
      },
      {
        "rank": "6",
        "suit": "Spades",
        "card": "6 of Spades",
        "short": "6♠"
      },
      {
        "rank": "3",
        "suit": "Clubs",
        "card": "3 of Clubs",
        "short": "3♣"
      },
      {
        "rank": "King",
        "suit": "Clubs",
        "card": "King of Clubs",
        "short": "K♣"
      },
      {
        "rank": "10",
        "suit": "Spades",
        "card": "10 of Spades",
        "short": "10♠"
      },
      {
        "rank": "6",
        "suit": "Hearts",
        "card": "6 of Hearts",
        "short": "6♥"
      },
      {
        "rank": "7",
        "suit": "Diamonds",
        "card": "7 of Diamonds",
        "short": "7♦"
      },
      {
        "rank": "Ace",
        "suit": "Clubs",
        "card": "Ace of Clubs",
        "short": "A♣"
      },
      {
        "rank": "3",
        "suit": "Spades",
        "card": "3 of Spades",
        "short": "3♠"
      },
      {
        "rank": "King",
        "suit": "Diamonds",
        "card": "King of Diamonds",
        "short": "K♦"
      },
      {
        "rank": "5",
        "suit": "Clubs",
        "card": "5 of Clubs",
        "short": "5♣"
      },
      {
        "rank": "Jack",
        "suit": "Clubs",
        "card": "Jack of Clubs",
        "short": "J♣"
      },
      {
        "rank": "8",
        "suit": "Diamonds",
        "card": "8 of Diamonds",
        "short": "8♦"
      },
      {
        "rank": "9",
        "suit": "Diamonds",
        "card": "9 of Diamonds",
        "short": "9♦"
      },
      {
        "rank": "5",
        "suit": "Hearts",
        "card": "5 of Hearts",
        "short": "5♥"
      },
      {
        "rank": "Queen",
        "suit": "Diamonds",
        "card": "Queen of Diamonds",
        "short": "Q♦"
      },
      {
        "rank": "8",
        "suit": "Clubs",
        "card": "8 of Clubs",
        "short": "8♣"
      },
      {
        "rank": "6",
        "suit": "Diamonds",
        "card": "6 of Diamonds",
        "short": "6♦"
      },
      {
        "rank": "8",
        "suit": "Spades",
        "card": "8 of Spades",
        "short": "8♠"
      },
      {
        "rank": "5",
        "suit": "Diamonds",
        "card": "5 of Diamonds",
        "short": "5♦"
      },
      {
        "rank": "7",
        "suit": "Spades",
        "card": "7 of Spades",
        "short": "7♠"
      },
      {
        "rank": "King",
        "suit": "Hearts",
        "card": "King of Hearts",
        "short": "K♥"
      },
      {
        "rank": "7",
        "suit": "Clubs",
        "card": "7 of Clubs",
        "short": "7♣"
      },
      {
        "rank": "5",
        "suit": "Spades",
        "card": "5 of Spades",
        "short": "5♠"
      },
      {
        "rank": "3",
        "suit": "Diamonds",
        "card": "3 of Diamonds",
        "short": "3♦"
      },
      {
        "rank": "2",
        "suit": "Clubs",
        "card": "2 of Clubs",
        "short": "2♣"
      },
      {
        "rank": "10",
        "suit": "Diamonds",
        "card": "10 of Diamonds",
        "short": "10♦"
      },
      {
        "rank": "9",
        "suit": "Clubs",
        "card": "9 of Clubs",
        "short": "9♣"
      },
      {
        "rank": "10",
        "suit": "Clubs",
        "card": "10 of Clubs",
        "short": "10♣"
      },
      {
        "rank": "9",
        "suit": "Hearts",
        "card": "9 of Hearts",
        "short": "9♥"
      }
    ],
    "top_card": {
      "rank": "3",
      "suit": "Hearts",
      "card": "3 of Hearts",
      "short": "3♥"
    },
    "bottom_card": {
      "rank": "9",
      "suit": "Hearts",
      "card": "9 of Hearts",
      "short": "9♥"
    },
    "sample_hand": [
      {
        "rank": "3",
        "suit": "Hearts",
        "card": "3 of Hearts",
        "short": "3♥"
      },
      {
        "rank": "Ace",
        "suit": "Hearts",
        "card": "Ace of Hearts",
        "short": "A♥"
      },
      {
        "rank": "4",
        "suit": "Hearts",
        "card": "4 of Hearts",
        "short": "4♥"
      },
      {
        "rank": "Queen",
        "suit": "Spades",
        "card": "Queen of Spades",
        "short": "Q♠"
      },
      {
        "rank": "4",
        "suit": "Diamonds",
        "card": "4 of Diamonds",
        "short": "4♦"
      }
    ]
  }
}

Error Handling

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

Basic Error Handling

from apiverve_carddeckshuffler.apiClient import CarddeckshufflerAPIClient, CarddeckshufflerAPIClientError

api = CarddeckshufflerAPIClient("[YOUR_API_KEY]")

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except CarddeckshufflerAPIClientError 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_carddeckshuffler.apiClient import CarddeckshufflerAPIClient, CarddeckshufflerAPIClientError

api = CarddeckshufflerAPIClient("[YOUR_API_KEY]")

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

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 CarddeckshufflerAPIClientError 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_carddeckshuffler.apiClient import CarddeckshufflerAPIClient, CarddeckshufflerAPIClientError

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

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

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

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

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

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_carddeckshuffler.apiClient import CarddeckshufflerAPIClient

api = CarddeckshufflerAPIClient("[YOUR_API_KEY]")

query = {
    "decks": 1,
    "jokers": ,
    "method": "fisher-yates"
}

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.

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)

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.

Project details

Release history Release notifications | RSS feed

This version

1.1.14

Feb 16, 2026

Download files

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

Source Distribution

apiverve_carddeckshuffler-1.1.14.tar.gz (13.8 kB view details)

Uploaded Feb 16, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

apiverve_carddeckshuffler-1.1.14-py3-none-any.whl (11.5 kB view details)

Uploaded Feb 16, 2026 Python 3

File details

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

File metadata

Download URL: apiverve_carddeckshuffler-1.1.14.tar.gz
Upload date: Feb 16, 2026
Size: 13.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_carddeckshuffler-1.1.14.tar.gz
Algorithm	Hash digest
SHA256	`e508b07b4b8985bca6ab71f67d04db455abca32177f7636f075c920ee928c3d3`
MD5	`0d6eb6d9e25dadb5a221daea119b3b84`
BLAKE2b-256	`c05133e01d3bb967f7e0072ed66c7c6278f4446cf257ed9d32df9bf084411209`

See more details on using hashes here.

File details

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

File metadata

Download URL: apiverve_carddeckshuffler-1.1.14-py3-none-any.whl
Upload date: Feb 16, 2026
Size: 11.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_carddeckshuffler-1.1.14-py3-none-any.whl
Algorithm	Hash digest
SHA256	`0b66bd359af871ecd0e963f97da03161617ee3f4b3e8ed07141b21cf5994d8c7`
MD5	`a9271e055f50b00bf90582f6159051d9`
BLAKE2b-256	`e1560762d367f2d10f0bb657ebdd7613c8ceb5ce8b90bf434877d61dec942abd`

See more details on using hashes here.

apiverve-carddeckshuffler 1.1.14

Navigation

Verified details

Maintainers

Meta

Unverified details

Project links

Meta

Classifiers

Project description

Card Deck Shuffler API

Installation

Configuration

Quick Start

Usage

Setup

Perform Request

Define Query

Simple Request

Example Response

Error Handling

Basic Error Handling

Handling Specific Error Types

Using Context Manager (Recommended)

Advanced Features

Debug Mode

Manual Session Management

Customer Support

Updates

Legal

License

Project details

Verified details

Maintainers

Meta

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes