Skip to main content

A Python SDK for Inworld AI

Project description

inworld-sdk

A Python SDK for interacting with Inworld AI's platform.

Description

This SDK provides a Python interface for working with Inworld AI'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 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 AI TTS system."
  sync_buffer = await client.tts.synthesizeSpeechAsWav(text)
  play_obj = sa.WaveObject.from_wave_file(sync_buffer)
  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.3.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.3.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inworld_sdk-0.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 83aa335cc10ed11829316c867f8c70c7cfb47c354c961112b2f8938d937abf0b
MD5 65d5fa255ef16da20d54027ff5efd321
BLAKE2b-256 fcb34ffc6bcbddf4c7c1cfa8a7bc64863a93631d4e927adc70bbac3618693154

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inworld_sdk-0.3.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 df1552fcfe16de6ac667006d2d769ab0943df535b71a078c6e0a223c3950c84e
MD5 78a95ac4ed73bd1784d900142198ff8d
BLAKE2b-256 dfded6bb791290a20a907f69a7b3c8f0ab0df70c6382897c3c9603ab773fbd13

See more details on using hashes here.

Provenance

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