example of using python-ts3 and install tutorial

This commit is contained in:
Krzysztof Jagiello
2011-06-04 20:29:07 +02:00
parent e12a490aee
commit 70ee4f052c

View File

@@ -5,3 +5,36 @@ python-ts3
python-ts3 is a abstraction library around the Teamspeak 3 ServerQuery API. It
allows native access to the ServerQuery API with most of the formatting
headaches avoided.
Install
========
Download the most recent sourcecode and install it:
git clone git://github.com/Balon/python-ts3.git
cd python-ts3
python setup.py install # sudo this
Example
========
Example showing how to create a channel and sub-channel for it using python-ts3 library:
import ts3
server = ts3.TS3Server('127.0.0.1', 10011)
server.login('serveradmin', 'secretpassword')
# choose virtual server
server.use(1)
# create a channel
response = server.send_command('channelcreate', keys={'channel_name': 'Just some channel'})
# id of the newly created channel
channel_id = response.response['keys']['cid']
# create a channel
server.send_command('channelcreate', keys={'channel_name': 'Just some sub-channel', 'cpid': channel_id})