ariamoradi/skyroom-python

skyroom api for python

skyroom-python

A library to ease skyroom api usage.

Link to api documentation: Skyroom RESTful API Documention

Installation

You can install this SDK from pypi through the command below

pip install skyroom

In order to use the api you need an API key. To obtain one you need to create an account on Skyroom and ask for your API key from the skyroom support.

Usage

Here are some examples for api usage(all methods use the same signature).

getRooms

from skyroom import *
try:
    api = SkyroomAPI('Your APIKey') # Example: apikey-71-819540-0f178abb0c712c4cfd5ae13e4c54687a
    response = api.getRooms()
    print(response)
except APIException as e: 
    print(e)
except HTTPException as e: 
    print(e)

getRoom

from skyroom import *
try:
    api = SkyroomAPI('Your APIKey') # Example: apikey-71-819540-0f178abb0c712c4cfd5ae13e4c54687a
    params = {
        'room_id': 1
    }
    response = api.getRoom(params)
    print(response)
except APIException as e: 
    print(e)
except HTTPException as e: 
    print(e)

getRoomUrl

from skyroom import *
try:
    api = SkyroomAPI('Your APIKey') # Example: apikey-71-819540-0f178abb0c712c4cfd5ae13e4c54687a
    params = {
        "room_id": 1,
        "language": "fa"
    }
    response = api.getRoomUrl(params)
    print(response)
except APIException as e: 
    print(e)
except HTTPException as e: 
    print(e)

Contribution

I no longer use this library in my code. If there are any updates on the upstream from skyroom you can add support for it by opening a pull request.

Anyways, Bug fixes, docs, and enhancements are allways welcome! just open an issue.

skyroom-python's Issues

مشکل در ایجاد کاربر با کاراکترهای فارسی

وقتی که متد
createUser
با پارامتری که دارای عبارات فارسی باشه فراخوانی بشه ارور با استاتوس 14 میده که نام کاربری باید بیشتر از 2 حرف و شامل حروف و اعداد باشه

params = {"username": "تست", 'password': "12345", 'nickname': "تستتست", 'status': 1, 'is_public': False}

accessing Attendance statistics through api

is there any method which could be used to access absense& presence statistics?

Refactoring whole project

کل پکیج باید یه ریفکتور اساسی بشه و ساختارش عوض شه
خوده اسکایروم برای توسعه این پکیج،‌توکن میده؟
اگه اسکایروم توکن تست میده و مایل باشید تغییرات جدید رو شروع کنم و یه دستی به کد بکشم.