# Lumapps SDK
<p align="center">
<a href="https://github.com/lumapps/lumapps-sdk/actions?query=workflow%3ACI"><img alt="Action Status" src="https://github.com/lumapps/lumapps-sdk/workflows/CI/badge.svg"></a>
<a href="https://pypi.org/project/lumapps-sdk/"><img alt="Pypi" src="https://img.shields.io/pypi/v/lumapps-sdk"></a>
<a href="https://codecov.io/gh/lumapps/lumapps-sdk/branch/master"><img alt="Coverage" src="https://codecov.io/gh/lumapps/lumapps-sdk/branch/master/graph/badge.svg"></a>
<a href="https://github.com/ambv/black"><img alt="Black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="#"><img alt="Black" src="https://img.shields.io/badge/python-3.8%7C3.9-blue"></a>
</p>
LumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/docs/start)
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. 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](https://sites.lumapps.com) and authenticate.
Once connected, open the javascript console of your browser and run:
```javascript
fetch(window.location.origin+"/service/user/token", {method: "POST"})
.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
```python
from lumapps.api import BaseClient
token = "MY TOKEN"
client = BaseClient(token=token)
```
3. Make your first API call
Let's display the full name of a registered user in lumapps
```python
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](https://lumapps.github.io/lumapps-sdk/).
## 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](CONTRIBUTING.md).
## Copyright and license
LumApps SDK is released under the [MIT license](LICENSE.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/lumapps/lumapps-sdk",
"name": "lumapps-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "lumapps-sdk,sdk,python",
"author": "Aur\u00e9lien Dentan",
"author_email": "aurelien@lumapps.com",
"download_url": "https://files.pythonhosted.org/packages/3f/9b/f284539e602feea1ff51903453be0167f2f2eab401a7161158625a8dd847/lumapps_sdk-1.2.8.tar.gz",
"platform": null,
"description": "# Lumapps SDK\n\n<p align=\"center\">\n <a href=\"https://github.com/lumapps/lumapps-sdk/actions?query=workflow%3ACI\"><img alt=\"Action Status\" src=\"https://github.com/lumapps/lumapps-sdk/workflows/CI/badge.svg\"></a>\n <a href=\"https://pypi.org/project/lumapps-sdk/\"><img alt=\"Pypi\" src=\"https://img.shields.io/pypi/v/lumapps-sdk\"></a>\n <a href=\"https://codecov.io/gh/lumapps/lumapps-sdk/branch/master\"><img alt=\"Coverage\" src=\"https://codecov.io/gh/lumapps/lumapps-sdk/branch/master/graph/badge.svg\"></a>\n <a href=\"https://github.com/ambv/black\"><img alt=\"Black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n <a href=\"#\"><img alt=\"Black\" src=\"https://img.shields.io/badge/python-3.8%7C3.9-blue\"></a>\n</p>\n\n\nLumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/docs/start)\n\nThis includes:\n\n- A client that support all the routes of the API (located in folder lumapps)\n- A set of helper classes to easily manipulate LumApps elements as Python Objects and classes (folder lumapps/helpers)\n\n\n## Installation\n\n```bash\npip install lumapps-sdk\n```\n\n## Requirements\n\nPython >= 3.8\n\n## Getting started\n\n1. Get your token\n\n LumApps supports multiple ways of authentication.\n The fastest one to implement is the following:\n\n Get your token by logging to your LumApps account.\n Go to [https://sites.lumapps.com](https://sites.lumapps.com) and authenticate.\n Once connected, open the javascript console of your browser and run:\n\n ```javascript\n fetch(window.location.origin+\"/service/user/token\", {method: \"POST\"})\n .then(data => {return data.json()})\n .then(res => {console.log(res.token)});\n ```\n\n This will generate your personal LumApps token that will be active for 60 minutes, and that we will use in the following steps\n\n2. Authenticate\n\n ```python\n from lumapps.api import BaseClient\n\n token = \"MY TOKEN\"\n client = BaseClient(token=token)\n ```\n\n3. Make your first API call\n\n Let's display the full name of a registered user in lumapps\n\n ```python\n user_email = \"YOUR EMAIL\"\n usr = api.get_call(\"user/get\", email=user_email)\n print(\"Hello {}\".format(usr[\"fullName\"]))\n ```\n\n## Documentation\n\nThe SDK documentation is available [here](https://lumapps.github.io/lumapps-sdk/).\n\n## Code convention\n\nDocstring in PEP 484 type annotations format adapted to python 2.7 using comments.\n\n## How to get help, contribute, or provide feedback\n\nPlease refer to our [contributing guidelines](CONTRIBUTING.md).\n\n## Copyright and license\n\nLumApps SDK is released under the [MIT license](LICENSE.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "1.2.8",
"project_urls": {
"Homepage": "https://github.com/lumapps/lumapps-sdk",
"Repository": "https://github.com/lumapps/lumapps-sdk"
},
"split_keywords": [
"lumapps-sdk",
"sdk",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2745d1560a2dd0685c1d13aa8439a54396cd04f1d5dd28ae96bb329a69a0e84",
"md5": "8a02133c97f2a12fdd40694d6fd482a9",
"sha256": "fb3812bb14bf2642ba00cb7cc0ff7248fdcb197946c6606360dde064bc3bf3b1"
},
"downloads": -1,
"filename": "lumapps_sdk-1.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a02133c97f2a12fdd40694d6fd482a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 200304,
"upload_time": "2023-12-05T16:31:43",
"upload_time_iso_8601": "2023-12-05T16:31:43.576555Z",
"url": "https://files.pythonhosted.org/packages/b2/74/5d1560a2dd0685c1d13aa8439a54396cd04f1d5dd28ae96bb329a69a0e84/lumapps_sdk-1.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f9bf284539e602feea1ff51903453be0167f2f2eab401a7161158625a8dd847",
"md5": "da0f81360a29e8e45b0652b0025db9d0",
"sha256": "9f4f7fa51cbecb53ba762df80e8822f69d78e17ee2215e4b6d2929a46ccc5b73"
},
"downloads": -1,
"filename": "lumapps_sdk-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "da0f81360a29e8e45b0652b0025db9d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 83158,
"upload_time": "2023-12-05T16:31:46",
"upload_time_iso_8601": "2023-12-05T16:31:46.740824Z",
"url": "https://files.pythonhosted.org/packages/3f/9b/f284539e602feea1ff51903453be0167f2f2eab401a7161158625a8dd847/lumapps_sdk-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 16:31:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lumapps",
"github_project": "lumapps-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lumapps-sdk"
}
JSON
