SDK (Python): Difference between revisions
(Created page with "{{stub|todo= * Overall structure * Running an example * How to leverage for development }} The Python SDK is a Software Development Kit written in and for Python, to assist in the creation of connections and interactions with the {{software}}. It is developed separately from the {{software}}'s internal source code, and is set up with the perspective of the developing end-user in mind. '''The Python SDK is a technical supplement for use with the {{software}}, and su...") |
|||
| Line 24: | Line 24: | ||
base64_password=YmFzZTY0ZW5jb2RlZHBhc3N3b3Jk | base64_password=YmFzZTY0ZW5jb2RlZHBhc3N3b3Jk | ||
}} | }} | ||
'''Note that this file should not be shared with anyone, as the username and password can be derived from it.''' | |||
This file should exist in the root of the project folder. It will be loaded in automatically when the pythonsdk is imported. | This file should exist in the root of the project folder. It will be loaded in automatically when the pythonsdk is imported. | ||
Revision as of 08:25, 21 June 2024
- Overall structure
- Running an example
- How to leverage for development
The Python SDK is a Software Development Kit written in and for Python, to assist in the creation of connections and interactions with the Tygron Platform. It is developed separately from the Tygron Platform's internal source code, and is set up with the perspective of the developing end-user in mind.
The Python SDK is a technical supplement for use with the Tygron Platform, and support for its use falls outside the standard license agreements.
Obtain and use
The Python SDK is offered free and open source on Github. It can be downloaded either using git, or as a direct zipped download.
The module should be a folder named tygronsdk, available for import by the python project in which it is to be used. This can be accomplished by placing the pythonsdk folder in the root of the project folder, the folder containing all the python code of the project the pythonsdk should be used in.
The pythonsdk can then be imported with:
import tygronsdk
Credentials
Because the Tygron Platform requires a valid account, credentials must be provided to authenticate and interact. Credentials can be provided by creating a file named credentials.txt with key-value entries for a username and a password. This will look approximately as follows:
username= base64_password=YmFzZTY0ZW5jb2RlZHBhc3N3b3Jk
Note that this file should not be shared with anyone, as the username and password can be derived from it.
This file should exist in the root of the project folder. It will be loaded in automatically when the pythonsdk is imported.