Using LexFloatClient with Python

Adding licensing to your app

After you've added a product for your app in the admin portal, you will need to do the following things:

• Note the product id for the product (from the actions menu in the table).

• Download the example project from Github

The product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.

Adding the library to your app

LexFloatClient wrapper for Python can be easily installed through pip:

pip install cryptlex.lexfloatclient

LexFloatClient requires the Microsoft Visual C++ 2015 (or later) Runtime on older Windows versions such as Windows 7, 8, or Server 2008/2012. If not already installed, install it from the official Visual C++ Redistributable or include the required DLLs with your installer.

Setting product id

The first LexFloatClient API function you need to use in your code is SetHostProductId(). It sets the product id of the product you will be adding licensing to.

LexFloatClient.SetHostProductId("PASTE_PRODUCT_ID");

Requesting floating license

To receive a floating license, you will use SetHostUrl(), SetFloatingLicenseCallback() and RequestFloatingLicense()LexFloatClient API methods. It sets the LexFloatServer address, the callback for status notifications, contacts the server and receives the floating license.

def main():
    try:
        LexFloatClient.SetHostProductId("PASTE_PRODUCT_ID")
        LexFloatClient.SetHostUrl("http://localhost:8090")
        LexFloatClient.SetFloatingLicenseCallback(licence_callback_fn)
        LexFloatClient.RequestFloatingLicense()
        print("Success! License acquired.)
    except LexFloatClientException as exception:
        print('Error code:', exception.code, exception.message)

The above code can be executed every time user starts the app or needs a new license.

Renewing floating license

License lease automatically renews itself in a background thread. When the license is renewed or fails to renew, the callback is invoked (from the background thread).

def licence_callback_fn(status):
    if LexFloatStatusCodes.LF_OK == status:
        print("The license lease has renewed successfully.")
    elif LexFloatStatusCodes.LF_E_LICENSE_NOT_FOUND == status:
        print("The license expired before it could be renewed.")
    elif LexFloatStatusCodes.LF_E_LICENSE_EXPIRED_INET == status:
        print("The license expired due to network connection failure.")
    else:
        print("The license renew failed due to other reason. Error code: ", status)

Dropping floating license

When your user is done using the app, the app should send a request to free the license, thereby making it available to other users. If the app doesn't, the license becomes useless (zombie) until lease time is over.

LexFloatClient.DropFloatingLicense()
print("Success! License dropped.")

The above code should be executed every time user closes the app.

Need more help

In case you need more help with adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our support forum or can contact us through email.