Download

Teamwire SDK is available as zip package:

Installation

Once having uncompressed the Teamwire_SDK_v1.6.0.zip package, you will get the following directory structure:

Teamwire_SDK_v1.6.0
├── API-TermsOfService.pdf
├── CHANGELOG.md
├── example_bots
│   ├── README.md
│   ├── echo.py
│   ├── greeting.py
│   └── managechat.py
├── examples
│   ├── README.md
│   ├── attention_messages.py
│   ├── avatar.py
│   ├── bot_info.py
│   ├── bot_profile.py
│   ├── create_chat.py
│   ├── live_location.py
│   ├── manage_chat.py
│   ├── message_logger.py
│   ├── profiles.py
│   └── requirements.txt
└── sdk
    ├── python-3.7
    │   ├── install.txt
    │   └── teamwire_api-1.6.0-py37-none-any.whl
    ├── python-3.8
    │   ├── install.txt
    │   └── teamwire_api-1.6.0-py38-none-any.whl
    └── python-3.9
        ├── install.txt
        └── teamwire_api-1.6.0-py39-none-any.whl

Depending on your Python environment of choice (Python 3.7, 3.8, 3.9), in order to install the Teamwire SDK module you have to follow the following steps:

  1. Go to the sdk/python-3.X directory of your choice. For example:

    $ cd Teamwire_SDK_v1.6.0/sdk/python-3.9

  2. Install the python package by running:

    pip install teamwire_api-1.6.0-py39-none-any.whl

This will install all dependencies and make the teamwire_api module available in your Python setup.

Feel free to check out the example bots and scripts contained in the example_bots and examples directories for a detailed view on how the SDK can be used to create chat bots and third party integrations.

Teamwire SDK Docker image

The Teamwire SDK is available on Teamwire's Harbor Registry as a base Docker image you can use to create your own bot images.

Please refer to the Running a bot with Docker section for learning how you can create a custom Docker image for your Teamwire bots.

Harbor access

Contact our support team in order to get access to Teamwire Harbor repositories