plusoft-api 0.1.3

No project description provided

plusoft-api

Use Edusense API funcionalities in your python application.

Instalation

pip install plusoft-api

Usage Examples

You can use this package in order to access Edusense API Rest Api Methods.

First one, you need to instantiate the PlusoftApi object, by passing your username, password and domain:

from plusoft_api import PlusoftApi


# We recommend the use of environment variables to improve security to your credentials
plusoft_api = PlusoftApi(
    username="your-login",
    password="your-password",
    domain="your-domain" # You can get this in your environment url, for example: https://{your-domain}.edusense.app
)

After that, you can access the api methods, for example to insert new users:

from plusoft_api import PlusoftApi


# We recommend the use of environment variables to improve security to your credentials
plusoft_api = PlusoftApi(
    username="your-login",
    password="your-password",
    domain="your-domain" # You can get this in your environment url, for example: https://{your-domain}.edusense.app
)

users = [
    {"login": "user1", "name": "User 1", "email": "[e-mail]"},
    {"login": "user2", "name": "User 2", "email": "[e-mail]"},
    {"login": "user3", "name": "User 3", "email": "[e-mail]"},
    {"login": "user4", "name": "User 4", "email": "[e-mail]"}
]

for user in users:
    plusoft_api.users.insert_users.add_to_payload(**user) # This method will check and store in memory the user to use later to generate payload and upload to plusoft

plusoft_api.users.insert_users.upload() # This method will upload to plusoft the users stored by add_to_payload method

This library is under development and not all methods are available.