Skip to main content

No project description provided

Project description

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lumapps-sdk-1.0.5.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

lumapps_sdk-1.0.5-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file lumapps-sdk-1.0.5.tar.gz.

File metadata

  • Download URL: lumapps-sdk-1.0.5.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.9 CPython/3.8.1 Linux/5.3.0-7625-generic

File hashes

Hashes for lumapps-sdk-1.0.5.tar.gz
Algorithm Hash digest
SHA256 4d82f84070707d9768b2bdefc17065b6c432117acb3d1cf065a741b07203aeaa
MD5 75f5e20865d36af1c5f0d39272958106
BLAKE2b-256 0b7507800638d58fb52925eaab7ef8fbb38f7e1c84b127e94c5e92cd9db0db9d

See more details on using hashes here.

File details

Details for the file lumapps_sdk-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: lumapps_sdk-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.9 CPython/3.8.1 Linux/5.3.0-7625-generic

File hashes

Hashes for lumapps_sdk-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e078e64a6f7b4682da421459327cbae77393459623404004bc4b73429ce6f1ac
MD5 c728d12947f478762074fb633fe1b5f2
BLAKE2b-256 ae79f1f9f8d06a9c443ff202355ad850acabb31dcd2f6330be06712a0ce2409d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page