applications/tg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adding doc for how to run script.

Browse Source
This commit is contained in:
Vincent Castellano 2015-06-05 02:05:24 -07:00
parent c170e98bf7
commit c31a7ef524
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README-PY.md
View File

@ -2,6 +2,8 @@ Python Bindings
====================
All of the functions and methods are executed in the network loop of tg, ***NOT IMMEDIATELY***. What this means is all calls should be considered async, and so there is an optional callback parameter for every function/method as the last parameter. For many uses, you won't care about the return value, so you can leave out the callback. Note there are a few cases where the callback is considered mandatory when the function is considered an information query and has no functionality without returned data. These will explicitly have the callback in the parameter list and will be noted in the description.
You can specify the python script from config ("python_script" option) or from command_line [-Z].
Version Notes
=====================
The python integration is written with Python 2/3 in mind, however, there is a bias to Python 3. Because of this, there are a few caveats: