Player2 for Python

A lightweight Python client designed to easily interact with Player2 Local Endpoints.

Installation

Install the package via pip:

pip install player2

Usage

1. Initialize the Client

When initializing the client, pass your game_id. It will automatically handle web login to fetch authorization keys and spin up a background health-check loop.

from player2 import APIClient

client = APIClient(game_id="your_game_id")  # Get the gameID from the player2 website

2. Chat Completions

Send user queries with optional system instructions:

response = client.chat(
    user="Hello, how are you doing today?",
    system="You are a helpful and witty assistant."
)

print(response)

3. Text-to-Speech (TTS)

Trigger speech generation locally:

tts_response = client.speak(
    text="Hello, how are you doing today?",
    instructions="Speak with a cheerful tone",
    speed=1.0
)

print(tts_response)

4. Speech-to-Text (STT)

Info This function is still untested and might not work, It's still W.I.P.

Trigger speech recording for 5 seconds and then stop.

from time import sleep # For this example, we will use time.sleep

client.start_stt()
sleep(5)
recording = client.stop_stt()

print(recording) # Returns the text in a JSON format.

5. Image Generation

Generate an image

generated_image_url = client.image(
    height=512, 
    width=512, 
    prompt="A cute cybernetic cat sitting on a neon rooftop at night"
).generate()

print(generated_image_url) # Print the image as a data URI

6. Image Editing

Edit an image

edited_image = client.image(
    height=512,
    width=512,
    prompt="Add a tiny astronaut helmet onto the cat's head",
    images=generated_image_url
).edit()

print(edited_image) # Print the image as a data URI