https://github.com/lumapps/lumapps-sdk
SDK to facilitate using LumApps API
https://github.com/lumapps/lumapps-sdk
integration lumapps python sdk-python
Last synced: 2 months ago
JSON representation
SDK to facilitate using LumApps API
- Host: GitHub
- URL: https://github.com/lumapps/lumapps-sdk
- Owner: lumapps
- License: mit
- Created: 2018-09-27T13:17:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-12-03T11:06:38.000Z (3 months ago)
- Last Synced: 2025-12-05T11:23:46.184Z (3 months ago)
- Topics: integration, lumapps, python, sdk-python
- Language: Python
- Homepage:
- Size: 10.6 MB
- Stars: 6
- Watchers: 28
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Lumapps SDK
LumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/)
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
```bash
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](https://developer.lumapps.com/documentation/oauth.html).
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.
```python
from lumapps.api import BaseClient
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
```python
usr = api.get_call("user/get", email="user.email@yourcompany.com")
print("Hello {}".format(usr["fullName"]))
```
## Documentation
The SDK documentation is available [here](https://lumapps.github.io/lumapps-sdk/).
## 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](CONTRIBUTING.md).
## Copyright and license
LumApps SDK is released under the [MIT license](LICENSE.md).