Lumapps SDK
Please be aware the this sdk is still in beta version (0.1) 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_api_client)
a set of helper classes to easily manipulate Lumapps elements as Python Objects and classes (folder lumapps_api_helpers)
Quick start
Installation
$ pip install lumapps-sdk
Get your token
Lumapps supports multiple ways of authentification. The fastest one to implement is the following:
Get your token by logging to your Lumapps account. Go to https://sites.lumapps.com and authentificate. 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
Authentificate
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 licensed under A MIT license - see the LICENSE.rst file.
Metadata
Release files for lumapps-sdk-fork-poetry 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lumapps-sdk-fork-poetry-0.2.2.tar.gz | 21.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lumapps_sdk_fork_poetry-0.2.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 46.7 kB
Release files / lumapps-sdk-fork-poetry-0.2.2.tar.gz
| Download URL | lumapps-sdk-fork-poetry-0.2.2.tar.gz |
|---|---|
| Size | 21.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f29393ac19dc410494e1fe9655875f58bef8584658921ee691f5156d7263755b
|
|
BLAKE2b-256 checksum How to use checksums |
263c044d03c6bbd2c7619be3ff948b497b4f05d924fc35c29476a4c1bed030e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.2 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.7
|
Release files / lumapps_sdk_fork_poetry-0.2.2-py2.py3-none-any.whl
| Download URL | lumapps_sdk_fork_poetry-0.2.2-py2.py3-none-any.whl |
|---|---|
| Size | 25.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a6655228f9ae58d2abb46a48eff1e6bf28134688347c1d917ee6a7021f930774
|
|
BLAKE2b-256 checksum How to use checksums |
548916c91e658343a53a4878eefa7194b9936c1f854a3a52657f554b4d8c9b3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.2 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.7
|