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

Requirements

Python >= 3.8

Getting started

  1. Set up your OAuth application

    Before anything else, you need to set up an OAuth application by following the steps in the LumApps Developer Portal.

  2. Authenticate

    Once your application set up, get a hand on its client ID and secret, then you can write the following to get an access token for a particular user.

    from lumapps.api import BaseClient
    
    token = "MY TOKEN"
    base_client = BaseClient(
        api_info={"base_url": "https://your-cell.api.lumapps.com"}, # e.g. "https://go-cell-001.api.lumapps.com"
        auth_info={
            "client_id": "your-client-id",
            "client_secret": "your-client-secret"
        }
    )
    
    api = base_client.get_new_client_as("user.email@yourcompany.com", customer_id="your-organization-id")
    
  3. Make your first API call

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

    usr = api.get_call("user/get", email="user.email@yourcompany.com")
    print("Hello {}".format(usr["fullName"]))
    

Documentation

The SDK documentation is available here.

Code convention

Docstring in PEP 484 type annotations format adapted to python 3.x 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-2.0.3.tar.gz (80.0 kB view details)

Uploaded Source

Built Distribution

lumapps_sdk-2.0.3-py3-none-any.whl (196.5 kB view details)

Uploaded Python 3

File details

Details for the file lumapps_sdk-2.0.3.tar.gz.

File metadata

  • Download URL: lumapps_sdk-2.0.3.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure

File hashes

Hashes for lumapps_sdk-2.0.3.tar.gz
Algorithm Hash digest
SHA256 37cb7a273025e169030b26ffd132f92c1fa8da1bb46c56e283edeb3373cdd100
MD5 38ba4434a0679812382076977347bfac
BLAKE2b-256 9f2696ddcacec6f22acf3b9f539576879c2f3257440b5ac3b36927a1adc5435d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lumapps_sdk-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 196.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure

File hashes

Hashes for lumapps_sdk-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e97848b7d7d00dc5e765043cd8787bc3ce6d6a737ef76b4e4c5578e4df2a4ad
MD5 0fd37d94380279518ad2e83564c146f0
BLAKE2b-256 3e1e21413d5b8a8442fb595733b68ae1f4ce380167506d640d85aa8cfc337fb0

See more details on using hashes here.

Supported by

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