Skip to main content

LumApps SDK

CI Coverage Status Pypi package Python versions Black style

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)

Installation

pip install lumapps-sdk

Getting started

1- 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[1] == "a" ? instance[3] : instance[1]
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

2 - Authenticate

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

3 - Make 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.

Release files for lumapps-sdk 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lumapps-sdk 1.0.4
File Size Uploaded
lumapps-sdk-1.0.4.tar.gz 17.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lumapps-sdk 1.0.4
File Interpreter ABI Platform
lumapps_sdk-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 36.8 kB

Release files / lumapps-sdk-1.0.4.tar.gz

Download URL lumapps-sdk-1.0.4.tar.gz
Size 17.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5c439464f13a015254bef021eca6dbfea20b1a4d4ccacba9d029524ee861a1eb
BLAKE2b-256 checksum
How to use checksums
90bd0eff86e50edd6178578b77810317212243929d6121e868ed288d88555311
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release files / lumapps_sdk-1.0.4-py3-none-any.whl

Download URL lumapps_sdk-1.0.4-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c1f0f8235248fd475480a998dceb23f3541b347633bf1ca3b67fb4d30d3cfea3
BLAKE2b-256 checksum
How to use checksums
0390dd98cd1afb535ac057f45dec1fb062d860fbeb50697463e8f5239e99c897
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release history Release notifications | RSS feed

2.0.3

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

This release

1.0.4 This release

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.19

2 release files

0.1.18

1 release file

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page