Updated README file, published release v2.1

Author: usrlibzy

README.md

@@ -4,22 +4,22 @@
 
 **Molly** is an open source package for python helping handling with the booking process of CDUT Library's study.
 
-This branch is for python *3.7+*, If you are seeking for previous support for python 2.7+, please check out branch *v1.0+*.
+This branch is for python *3.7+*, If you are seeking for previous support for python 2.7+, please check out branch *v1.0+*, which still works but will not be maintained continuously.
 
 ## Installation
 
 First, install all the dependencies that are required for this package.
 ```
 python3 -m pip install terminaltables beautifulsoup4
 ```
-Then clone all the files to your computer(mostly a server for continuous support).
+Then clone all the files to your computer(mostly a server to ensure availability).
 
 ## Contents
 
 |File|Detail|
 |-|-|
 |**dinner.py**|main library file that contains all the methods that you need to handle the boring works|
-|**cafe.py**|main application file that automatically book a study for you in case you asked him to in advance|
+|**cafe.py**|main application file that automatically book a study for you in advance|
 |**porter.py**|application file that helps to generate booking configurations|
 |**kitchens.json**|the file containing all the information of the  studies in CDUT library|
 |**credits.json**|the file containing login information|
@@ -39,7 +39,7 @@ Create a file named **credits.json** besides dinner.py with your login credentia
 }
 ```
 
-### dinner.py customizations
+### dinner.py customization
 
 If you would like to use dinner directly in the terminal, simply navigate to the folder and import dinner, dinner.py will initialize itself automatically and then you are free to use all the methods.
 
@@ -49,15 +49,18 @@ Otherwise, you may need to set `standbyMode` to `True` if you are using it in sc
 
 ### dinner.py api cheatsheet
 
+This file contains quite a lot of methods that you may need for your application. Discover high-level usages yourself.
+
 #### init()
 
-Initialize the library, including checking connection to the system, loading room information from file and so on.
+Initialize the library, including checking the connection to the system interface, loading room information, login credits from file and so on.
 
 |Parameter|Type|Default|Example|Detail|
 |-|-|-|-|-|
 |`ignoreConnectionFault`|bool|False|True|wether exit on connection failure|
+|`dynamicLoginCredits`|dict|None|{"user": 201906010101, "passwd": "010101"}|making the appplication more flexible|
 
-Notice that if `standbyMode` is set to `True`, the script will not exit just as `ignoreConectionFault = True` will do.
+Notice that if `standbyMode` is set to `True`, the script will not exit just as `ignoreConectionFault = True` does.
 
 |Return value|Type|Detail|
 |-|-|-|
@@ -173,9 +176,9 @@ Renew the room which is currently used for further 2 hours if not occupied by ot
 
 |Parameter|Type|Default|Example|Detail|
 |-|-|-|-|-|
-|`bookingId`|int|`None`|393487|could be obtained using `getMyBookingInfo()`|
+|`bookingId`|int|`None`|393487|could be obtained using `getUserBookingInfo()`|
 
-Cancel a room with the specific `bookingId` which could be got by using `getMyBookingInfo()` funcion.
+Cancel a room with the specific `bookingId` which could be got by using `getUserBookingInfo()` funcion.
 Return `True` if successful, or error message if failed.
 
 |Return value|Type|Detail|
@@ -185,7 +188,7 @@ Return `True` if successful, or error message if failed.
 |`Exception_ConnectionTimeOut`|str|connection to remote server could not be established|
 |`<errorMessage>`|str|details of the failure|
 
-#### getMyBookingInfo(prettified = False)
+#### getUserBookingInfo(prettified = False)
 
 |Parameter|Type|Default|Example|Detail|
 |-|-|-|-|-|
@@ -194,7 +197,7 @@ Return `True` if successful, or error message if failed.
 Refresh the cookie and make the query, then return the booking information of the current user.
 Set parameter `prettified` to `True` to use terminal-tables which makes it easier to check the information returnded.
 
-Notice that once you have signed up at the entrance of the study or the time(20 minutes) has passed without your signing-up, the entry will disappear from there. So you may have to use `getMyBookingHistory()` instead.
+Notice that once you have signed up at the entrance of the study or the time(20 minutes) has passed without your signing-up, the entry will disappear from there. So you may have to use `getUserBookingHistory()` instead.
 
 |Return value|Type|Detail|
 |-|-|-|
@@ -203,7 +206,7 @@ Notice that once you have signed up at the entrance of the study or the time(20
 |`Exception_ConnectionTimeOut`|str|connection to remote server could not be established|
 |`Exception_DataStreamBroken`|str|process interrupted when handling data, retrying may help mostly|
 
-#### getMyBookingHistory()
+#### getUserBookingHistory()
 
 |Parameter|Type|Default|Example|Detail|
 |-|-|-|-|-|
@@ -217,7 +220,7 @@ Notice that once you have signed up at the entrance of the study or the time(20
 |`Exception_ConnectionTimeOut`|str|connection to remote server could not be established|
 |`Exception_DataStreamBroken`|str|process interrupted when handling data, retrying may help mostly|
 
-### cafe.py automatic booking configurations
+### cafe.py: automatic-booking helper
 
 Creat a new file named **recipe.json**, where you are free to present your booking tasks to cafe.py like this below:
 
@@ -248,17 +251,18 @@ Creat a new file named **recipe.json**, where you are free to present your booki
 |Parameter|Type|Example|Detail|
 |-|-|-|-|
 |`roomId`|int|125|\|
-|`users`|dic|`[201906010326,201906010328]`|\|
+|`users`|dict|`[201906010326,201906010328]`|\|
 |`startAt`|str|`'2019-11-03 09:40:00'`|`startDate+" "+startTime`|
 |`endAt`|str|`'2019-11-03 13:40:00'`|`endDate+" "+endTime`|
 |`triggerAt`|str|`'2019-11-03 09:40:00'`|\|
 
 The default basic configurations like debug mode, retry intervals are listed below, you are free to modify them in **cafe.py** file.
 
-|Parameter|Type|Default|Detail|
+|Option|Type|Default|Detail|
 |-|-|-|-|
-|`recipeFileName`|str|`"recipe.json"`|\|
-|`refreshRecipeCycle`|int|`60`|\|
+|`debugMode`|bool|`True`|whether to display detailed logs|
+|`recipeFileName`|str|`"recipe.json"`|configuration file to import from|
+|`shelfDirectory`|str|`"./shelf/"`|configuration entries|
 |`retryTimes`|int|`5`|\|
 |`retryInterval`|int|`1`|\|
 |`standbyInterval`|int|`1`|\|
@@ -269,18 +273,32 @@ Since v2.0, cafe.py has the ability to recover its task queue after restarting,
 
 All the essential process logs could be found in **beans.txt** for debugging purposes.
 
+If you run cafe on server, suggesting using [supervisor](https://github.com/Supervisor/supervisor).
+
+### porter.py: automatic-booking helper configurations generator
+
+No documentation on this for you.
+
 ## Contributions
 
-Notice: according to the license, you are required to make appropriate contributions to this project in case you run it. Check out [Toay's pre-mit license](https://toay.org/projects/pre-mit-license) for more information.
+2020/03/16, this repo is turned public.
 
-You can make contributions to this project in the following ways.
+According to the license, you are expected to make appropriate contributions to this project in case you make use of it.
 
+You can make contributions to this project in various ways.
+
+* help with those listed in Todos
 * complete the library file **dinner.py** by add functions or making optimizations
-* complete the application file **cafe.py**
-* making your application using library **dinner.py** and publish your project using the same license
+* build your great application using library **dinner.py** and publish your project using the same license
+
+Check out [Toay's pre-mit license](https://toay.org/projects/pre-mit-license) for more information.
+
+### Todos
+
+* package the project up using pypi standard and publish
 
 ## This and that
 
-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 not to hesitate joining us.
+This project is maintained by twikor @ **[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 not to hesitate joining us.
 
-For more information, please have a look at **[this](https://toay.org/about/signing-up)**.
+For more information, please have a look at **[this](https://toay.org/about/signing-up)**.

cafe.py

@@ -43,7 +43,7 @@ def bindFailure(details = None):
 
 def sweetsOut(outputContent):
     if (debugMode == True):
-        print("[MoCafe " + time.strftime('%m-%d %H:%M:%S',time.localtime(time.time())) + "] " + outputContent)
+        print("[Molly " + time.strftime('%m-%d %H:%M:%S',time.localtime(time.time())) + "] " + outputContent)
 
 # function: storing of the log data
 
@@ -56,7 +56,7 @@ def beansOut(coffeeBeans):
             os.system('touch beans.txt')
 
         coffeeBeansFile = open('beans.txt', 'a')
-        contentLineToWrite = str("[MoCafe " + time.strftime('%m-%d %H:%M:%S',time.localtime(time.time())) + "] " + coffeeBeans + '\n')
+        contentLineToWrite = str("[Molly " + time.strftime('%m-%d %H:%M:%S',time.localtime(time.time())) + "] " + coffeeBeans + '\n')
         coffeeBeansFile.write(contentLineToWrite)
         coffeeBeansFile.close()
 

porter.py

@@ -28,7 +28,7 @@
 
     # basic settings
 
-    operationInitialDelay = 10
+    operationInitialDelay = 10#minimal intervals between two operations, same trigger date
     shelfDirectory = "./shelf/"
     creditsFile = "./credits.json"
     recipeFile = "./recipe.json"
@@ -47,7 +47,7 @@
     4. port configurations to task queue\n\
     q. exit\n\
 ctrl + c to return to this menu\n\
-Force exit? try using duble ctrl + c twice\n\
+Force exit? try using ctrl + c twice\n\
 -----")
 
     try: