Skip to main content

A Python SDK for Inworld

Project description

inworld-sdk

A Python SDK for interacting with Inworld's platform.

Description

This SDK provides a Python interface for working with Inworld's services, making it easy to integrate AI characters into your applications.

Currently, this SDK only supports the TTS API.

Installation

You can install the package using pip:

pip install inworld-sdk

For development installation:

# Clone the repository
git clone https://github.com/MichaelSolati/inworld-sdk-python.git
cd inworld-sdk-python

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows, use: .\venv\Scripts\activate

# Install the package in development mode with all dependencies
pip install -e .

Basic Usage

import asyncio
import base64
import io

import simpleaudio as sa

from inworld_sdk import InworldClient


async def main():
  # Initialize the client
  client = InworldClient(api_key="<YOUR_API_KEY>")
  client.tts.update_options(audioEncoding="LINEAR16")

  # Example: Get voices
  voices = await client.tts.voices()
  print(voices)

  # Example: Synthesize and play speech
  text = "Hello! This is a test of the Inworld TTS system."
  synthesizedSpeech = await client.tts.synthesizeSpeech(text)
  audio_content = synthesizedSpeech.get("audioContent")
  decoded_audio = base64.b64decode(audio_content)
  wav_file = io.BytesIO(decoded_audio)
  play_obj = sa.WaveObject.from_wave_file(wav_file)
  play_obj.play().wait_done()


if __name__ == "__main__":
  asyncio.run(main())

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Project details


Download files

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

Source Distribution

inworld_sdk-0.7.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

inworld_sdk-0.7.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file inworld_sdk-0.7.0.tar.gz.

File metadata

  • Download URL: inworld_sdk-0.7.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inworld_sdk-0.7.0.tar.gz
Algorithm Hash digest
SHA256 bf702129311bda2e190118d815452f050d238ad51641ad80130ceafd60b5278c
MD5 78dd68f76b6d08efa0ca986cbf6e41f6
BLAKE2b-256 4ce32018750db3110caa13c65b7349b32e726f9f9ce2a16af9e5afeeda6774c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for inworld_sdk-0.7.0.tar.gz:

Publisher: release.yml on MichaelSolati/inworld-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file inworld_sdk-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: inworld_sdk-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inworld_sdk-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b7afb827732e299d63cf954666f52acf79dd7eb1c354151d258b892a120b0de
MD5 baf2b6796df9ed9381dc8daa3cdbb541
BLAKE2b-256 14d0f91796438a88b248536b94fc9dde919d51d5bff981e616666a78b03ce0c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for inworld_sdk-0.7.0-py3-none-any.whl:

Publisher: release.yml on MichaelSolati/inworld-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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