SingularityNET SDK for Python
The package is published in PyPI at the following link:
| Package | Description |
|---|---|
| snet-sdk | Integrate SingularityNET services seamlessly into Python applications |
These instructions are for the development and use of the SingularityNET SDK for Python.
The SingularityNET SDK allows you to make calls to SingularityNET services programmatically from your application. To communicate between clients and services, SingularityNET uses gRPC. To handle payment of services, SingularityNET uses Ethereum state channels. The SingularityNET SDK abstracts and manages state channels with service providers on behalf of the user and handles authentication with the SingularityNET services.
To call a SingularityNET service, the user must be able to deposit funds (AGI tokens) to the Multi-Party Escrow Smart Contract. To deposit these tokens or do any other transaction on the Ethereum blockchain, the user must possess an Ethereum identity with available Ether.
Once you have installed the snet-sdk in your current environment and it's in your PYTHONPATH, you should import it and create an instance of the base sdk class:
from snet import sdk
from config import config
snet_sdk = sdk.SnetSDK(config)The config parameter must be a Python dictionary.
See test_sdk_client.py.sample for a sample configuration file.
After executing this code, you should have client libraries created for this service. They are located in the following path: ~/.snet/org_id/service_id/python/
Note: Currently you can only save files to ~/.snet/
If you want to use free call you need to add below mwntioned attributes in config file.
"free_call_auth_token-bin":"f2548d27ffd319b9c05918eeac15ebab934e5cfcd68e1ec3db2b92765",
"free-call-token-expiry-block":172800,
"email":"[email protected]"
You can download this config for a given service from Dapp
Now, the instance of the sdk can be used to create service client instances.
Continuing from the previous code this is an example using Exampleservicee from the 26072b8b6a0e448180f8c0e702ab6d2f organization:
import example_service_pb2_grpc
org_id = "26072b8b6a0e448180f8c0e702ab6d2f"
service_id = "Exampleservice"
group_name="default_group"
service_client = snet_sdk.create_service_client(org_id, service_id, group_name)Note that org_id and service_id must be passed to config.
The generated service_client instance can be used to call methods provided by the service. To call these methods, you need to use the call_rpc method, passing into it the names of the method and data object, as well as the data itself (What specific data needs to be passed can be seen in the .proto file). Continuing from the previous code, this is an example using example-service from the snet organization:
result = service_client.call_rpc("mul", "Numbers", a=20, b=3)
print(f"Performing 20 * 3: {result}") # Performing 20 * 3: value: 60.0You can get this code example at https://github.com/singnet/snet-code-examples/tree/python_client/python/client
For more information about gRPC and how to use it with Python, please see:
- Clone the git repository
$ git clone [email protected]:singnet/snet-sdk-python.git
$ cd snet-sdk-python- Install the required dependencies
$ pip install -r requirements.txt- Install the package in development/editable mode
$ pip install -e .This project is licensed under the MIT License - see the LICENSE file for details.