Metadata-Version: 2.1
Name: lumapps-sdk
Version: 1.0.2
Summary: LumApps SDK for Python
Home-page: https://github.com/lumapps/lumapps-sdk
Author: LumApps
License: MIT
Project-URL: Documentation, https://lumapps.github.io/lumapps-sdk/
Project-URL: Source, https://github.com/lumapps/lumapps-sdk
Project-URL: Issues, https://github.com/lumapps/lumapps-sdk/issues
Project-URL: CI, https://circleci.com/gh/lumapps/lumapps-sdk
Description: **LumApps SDK**
        ===============
        
        |CI| |Coverage Status| |PyPI Status| |Python Versions| |Style Badge|
        
        
        *Please be aware the this sdk is still in beta version and is undergoing a fast paced evolution that may break change the behaviour of some helpers*
        
        *Make sure of the version you are using (Git tags & releases)*
        
        ----
        
        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
        ============
        
        ``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 <https://sites.lumapps.com>`_ and authenticate.
        Once connected, open the javascript console of your browser and run:
        
        .. code-block:: javascript
        
            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
        ----------------
        
        .. code-block:: python
        
            from lumapps.api import ApiClient
            token = "MY TOKEN"
            api = ApiClient(token=token)
        
        3 - Make your first API call
        ----------------------------
        
        Let's display the full name of a registered user in lumapps
        
        .. code-block:: python
        
            user_email = "YOUR EMAIL"
            usr = api.get_call("user", "get", email=user_email)
            print("Hello {}".format(usr.get("fullName", "")))
        
        
        
        Documentation
        =============
        
        The SDK documentation is available `here <https://github.com/lumapps/lumapps-sdk/wiki>`_.
        
        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 <https://lumapps.github.io/lumapps-sdk/contributing.html#contributing-to-code>`_.
        
        Copyright and license
        =====================
        
        LumApps SDK is released under the MIT license - see the `LICENSE.rst <LICENSE.RST>`_ file.
        
        
        .. |CI| image:: https://github.com/lumapps/lumapps-sdk/workflows/CI/badge.svg
             :target: https://github.com/lumapps/lumapps-sdk/actions?query=workflow%3ACI
             :alt: CI
        
        .. |PyPI Status| image:: https://img.shields.io/pypi/v/lumapps-sdk
            :target: https://pypi.org/project/lumapps-sdk/
            :alt: Pypi package
        
        .. |Coverage Status| image:: https://codecov.io/gh/lumapps/lumapps-sdk/branch/v1.0/graph/badge.svg
            :target: https://codecov.io/gh/lumapps/lumapps-sdk/branch/v1.0
        
        .. |Style Badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/ambv/black
            :alt: Black style
        
        .. |Python Versions| image:: https://img.shields.io/badge/python-3.6%7C3.7%7C3.8-blue
            :alt: Python versions
        
Keywords: lumapps sdk
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
