Skip to main content

Lumapps SDK

Action Status Pypi Coverage Black Black

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"
    client = 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["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.

Metadata

Release files for lumapps-sdk 1.0.5

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.5
File Size Uploaded
lumapps-sdk-1.0.5.tar.gz 18.0 kB Details

Built distribution (wheel)

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

Total release size: 39.5 kB

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

Download URL lumapps-sdk-1.0.5.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4d82f84070707d9768b2bdefc17065b6c432117acb3d1cf065a741b07203aeaa
BLAKE2b-256 checksum
How to use checksums
0b7507800638d58fb52925eaab7ef8fbb38f7e1c84b127e94c5e92cd9db0db9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.9 CPython/3.8.1 Linux/5.3.0-7625-generic

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

Download URL lumapps_sdk-1.0.5-py3-none-any.whl
Size 21.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e078e64a6f7b4682da421459327cbae77393459623404004bc4b73429ce6f1ac
BLAKE2b-256 checksum
How to use checksums
ae79f1f9f8d06a9c443ff202355ad850acabb31dcd2f6330be06712a0ce2409d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.9 CPython/3.8.1 Linux/5.3.0-7625-generic

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

This release

1.0.5 This release

2 release files

1.0.4

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