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 ".[dev]"

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>")

  # 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.4.0.tar.gz (7.6 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.4.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inworld_sdk-0.4.0.tar.gz
  • Upload date:
  • Size: 7.6 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.4.0.tar.gz
Algorithm Hash digest
SHA256 3fe785ea53690df3447996c9c12a8d163cdb18556020ae6c0f339df13fcca3bd
MD5 4c8887f3a88f1b36c41ad9775264e683
BLAKE2b-256 f51df7980e727b5f5baf47ee142064a6e0ef57100a9bfbebd1c23f984999a100

See more details on using hashes here.

Provenance

The following attestation bundles were made for inworld_sdk-0.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: inworld_sdk-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0f8e62084405bbdfb1eb90fbf969fe3270676eec23b0450995f8c9280ba2831
MD5 74cdb4632b6f8b63987b46817533edde
BLAKE2b-256 b706d108f391a975640d267ac7b60d02cc18404a90020037d4a68fcbbd7537e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for inworld_sdk-0.4.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