Skip to main content

Trusted Twin Python client

Project description

TrustedTwin Python Client (external info)

The Trusted Twin Python library makes it easy to use the Trusted Twin user infrastructure API in Python applications. The library version is consistent with the Swagger version of the Trusted Twin API.

Client offers synchronous and asynchronous versions which can be used for communication with TT API.

Requirements

Library requires Python3.6+.

Installation

For synchronous API client:

pip install trustedtwin

To use asynchronous client:

pip install trustedtwin[async]

By default, additional packages required by asynchronous version are not installed.

Usage

Authorization

For synchronous client:

from trustedtwin.tt_api import TTRESTService

TT_SERVICE = TTRESTService(auth=$USER_SECRET)

For asynchronous client:

from trustedtwin.tt_api_async import TTAsyncRESTService

TT_SERVICE = TTAsyncRESTService(auth=$USER_SECRET)

Example calls

For synchronous client:

import json 
from trustedtwin.tt_api import TTRESTService

status, response = TTRESTService().create_user_secret($ACCOUNT_UUID, $PIN)
resp = json.loads(response)

TT_SERVICE = TTRESTService(tt_auth=resp['secret'])

_body = {
    'description': {
        'custom_name': 'custom_value'
    }
}

status, response = TT_SERVICE.create_twin(body=_body)
resp = json.loads(response)

For asynchronous client:

import json 
from trustedtwin.tt_api_async import TTAsyncRESTService

status, response = await TTAsyncRESTService().create_user_secret($ACCOUNT_UUID, $PIN)
resp = json.loads(response)

TT_SERVICE = TTAsyncRESTService(tt_auth=resp['secret'])

_body = {
    'description': {
        'custom_name': 'custom_value'
    }
}

status, response = await TT_SERVICE.create_twin(body=_body)
resp = json.loads(response)

For more information please navigate to the official documentation.

TrustedTwin Python Client (internal info)

Updating the library

To update the Python library to the newest version:

  1. Upload a tt_api.yaml file corresponding with the respective API version.
  2. In the Gitlab interface in the left-hand side pane, select Build and go to the Pipeline schedules section.
  3. By the Deploy to official pyPi repository schedule, click on the Run pipeline schedule button.

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

trustedtwin-3.13.20240314223736.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

trustedtwin-3.13.20240314223736-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

Details for the file trustedtwin-3.13.20240314223736.tar.gz.

File metadata

File hashes

Hashes for trustedtwin-3.13.20240314223736.tar.gz
Algorithm Hash digest
SHA256 e2f5250bd2d9eb3e78ccde7fed168cb5feee39906c8dde82bf964a9c1ac77b71
MD5 a291fb029709d778926208c811951f27
BLAKE2b-256 99137c830830e4dada9a35d47de30484559df928bb20bca199ce54f3ee79f35a

See more details on using hashes here.

File details

Details for the file trustedtwin-3.13.20240314223736-py3-none-any.whl.

File metadata

File hashes

Hashes for trustedtwin-3.13.20240314223736-py3-none-any.whl
Algorithm Hash digest
SHA256 ef9c970b5fe8bb8f4d1b6271649b42cab990cd0005f202de2e91fa4ff8bf3c1b
MD5 b77e9e4b4784157ba211df74200cb939
BLAKE2b-256 69979a7adfb2be4e22a7dc8c89795feac4f6b0dc7dea2645f6280ba15bc13db5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page