Published release v1.0

Author: usrlibzy

README.md

@@ -1,6 +1,6 @@
-# Molly - An intensive python package for study-booking system of CDUT Library
+# Molly - A powerful intensive python package for study-booking system of CDUT Library
 
-**This is one of the projects by Twikor. For more, take a step to my blog [Twikor's (twic.me)](https://twic.me).**
+**This is one of the projects by Twikor. It is not unusual for me to have more on my blog [Twikor's (twic.me)](https://twic.me).**
 
 **Molly** is an open source package for python helping handling with the booking process of CDUT Library's study.
 
@@ -52,6 +52,12 @@ Otherwise, you may need to set `standbyMode` to `True` if you are using it in sc
 
 Initialize the library, including checking connection to the system, loading room information from file and so on.
 
+|Parameter|Type|Default|Example|Detail|
+|-|-|-|-|-|
+|`ignoreConnectionFault`|bool|False|True|wether exit on connection failure|
+
+Notice that if `standbyMode` is set to `True`, the script will not exit just as `ignoreCoonectionFault = True` will do.
+
 |Return value|Type|Detail
 |-|-|-|
 |`True`|bool|\|
@@ -105,6 +111,8 @@ Defaultly return the booking information for a given id of a room in json format
 
 |Parameter|Type|Default|Example|Detail|
 |-|-|-|-|-|
+|`roomId`|int|None|`125`|could be obtained using `getRoomIdByNumber()`|
+|`prettified`|bool|`False`|True|whether to use the data to render a user-friendly table in terminal|
 
 Defaultly return the booking information for a given id of a room in json format. If setting parameter 2 to True, it will use terminaltables to render a prettier user interface right in your browser.
 
@@ -234,4 +242,4 @@ You can make contributions to this project in the following ways.
 
 Thisn project is maintained by twikor at **[Toay laboratory](https://toay.org)**, a place where we enjoy making creative things. We hope the ones who think of themselves useful to a newly-founded non-profit studio for creators, please don't hesitate joining us.
 
-For more information, please have a look at **[this](https://toay.org/about/sigining-up)**.
+For more information, please have a look at **[this](https://toay.org/about/signing-up)**.

dinner.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #-*- coding:utf-8 -*-
 
-## An one-file python library for study-booking system of CDUT Library.
+## An intensive python library for study-booking system of CDUT Library.
 ##
 ## This work is under Toay's PRE-MIT license with extra agreement that:
 ##  - to help protecting the server, rate limit must be setted below 1 rps
@@ -45,14 +45,12 @@ def init(ignoreConnectionFault = False):
     connectionResult = connection.connect_ex((socketIp, socketPort))
 
     if connectionResult != 0:
-        if (ignoreConnectionFault == False):
+        if (ignoreConnectionFault == False or standbyMode != True):
             print "remote server could not be connected, script exited :("
             connection.close()
             sys.exit(0)
         else:
-            if (standbyMode != True):
-                print "remote server could not be connected :("
-
+            print "remote server could not be connected, ignoring :("
             connection.close()
             excepted = "Exception_RemoteServerUnreachable"
             return excepted
@@ -223,43 +221,6 @@ def getUserInfoByCode(code = None, pretiffied = False):
                 generateTable = AsciiTable(tableData, tableTitle)
                 return generateTable.table
 
-'''
-
-# function: get the booking info for a specific room
-
-def getRoomBookingInfo(roomId = None, prettified = False):
-    cookies = getFreshCookie()
-    if (roomId == None):
-        print "lacking parameters, function getRoomBookingInfo exited :("
-        return False
-    else:
-        getRoomBookingInfoUrl = socketUrl + "datafeed"
-        parameters = {'method':'list', 'id':roomId}
-        getRoomBookingInfoResponse = requests.get(getRoomBookingInfoUrl, params = parameters)
-        roomBookingInfo = getRoomBookingInfoResponse
-        roomBookingInfoDict = roomBookingInfo.json()
-        roomBookingInfoJsonText = json.dumps(roomBookingInfoDict, ensure_ascii = False)
-        roomBookingInfoDict = json.load(roomBookingInfoDict)
-        roomBookingEvents = roomBookingInfo['events']
-
-        if (prettified == False):
-            roomBookingTimeList = []
-            for roomBookingEvent in roomBookingEvents:
-                roomBookTimeListEntry = {
-                    'start':roomBookingEvent[2],
-                    'end':roomBookingEvent[3]
-                    }
-                roomBookTimeList.append(roomBookTimeListEntry)
-
-            roomBookingTimeListJson = json.dumps(roomBookingTimeList, ensure_ascii = False)
-            return roomBookingTimeListJson
-        else:
-            roomBookingTimeTable = []
-            bookingEvents = roomBookingInfo['events']
-            tableData = [['Start', 'End']]
-
-'''
-
 # function: get the detailed booking information for a specific room
 
 def getRoomBookingInfo(roomId = None, prettified = False, detailed = False):
@@ -356,23 +317,6 @@ def getRoomBookingInfo(roomId = None, prettified = False, detailed = False):
                 generateTable = AsciiTable(tableData, tableTitle)
                 return generateTable.table
 
-'''
-
-# function: get the detailed booking info for all rooms
-
-def getAllCurrentBookableRoomsInfo():
-    global kitchens
-    if (type == None):
-        print "lacking parameters, function getAllBookingInfo exited :("
-        return False
-    else:
-        allBookingInfo = []
-        for room in kitchens:
-            allBookingInfo.append(getBookingInfo(room['roomId']))
-    return allBookingInfo
-
-'''
-
 # function: book a room using the cookie got freshly
 
 def bookRoom(users = None, roomId = None, beginDay = None, beginTime = None, endDay = None, endTime = None):