README.rst

Lumapps SDK

Please be aware the this sdk is still in beta version and is undergoing a fast paced evolution that may break change the behaviour of some helpers

Make sure of the version you are using (Git tags & releases)

---

LumApps SDK is a set of tools to manipulate the Lumapps API.

This includes:

• a client that support all the routes of the API (located in folder lumapps)
• a set of helper classes to easily manipulate LumApps elements as Python Objects and classes (folder lumapps/helpers)

Quick start

Installation

$ pip install lumapps-sdk

Get your token

LumApps supports multiple ways of authentication. The fastest one to implement is the following:

Get your token by logging to your LumApps account. Go to https://sites.lumapps.com and authenticate. Once connected, open the javascript console of your browser and run:

var instance = window.location.pathname.split('/');
instance = instance[instance.length-2];
fetch(window.location.origin+"/service/init?customerHost="+window.location.host+"&instanceSlug="+instance+"&slug=").then(data=>{return data.json()}).then(res => {console.log(res.token)})

This will generate your personal Lumapps token that will be active for 60 minutes, and that we will use in the following steps

Authenticate

from lumapps.client import ApiClient
token = "MY TOKEN"
api = ApiClient(token=token)

Your first API call

Let's display the full name of a registered user in lumapps

user_email = "YOUR EMAIL"
usr = api.get_call("user", "get", email=user_email)
print("Hello {}".format(usr.get("fullName", "")))

Documentation

The SDK documentation is available here.

Code convention

Docstring in PEP 484 type annotations format adapted to python 2.7 using comments.

How to get help, contribute, or provide feedback

Please refer to our contributing guidelines.

Copyright and license

LumApps SDK is released under the MIT license - see the LICENSE.rst file.