nikdoof / python-ts3 Goto Github PK

Teamspeak 3 API module for Python 2/3

License: BSD 3-Clause "New" or "Revised" License

Python 100.00%

python-ts3's Introduction

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.

Python Support

python-ts3 is targeted at Python 2.6/2.7/3.2/3.3 support, along with PyPy support.

Install

Download the most recent sourcecode and install it::

git clone git://github.com/nikdoof/python-ts3.git
cd python-ts3
python setup.py install

A stable version of python-ts3 is available on PyPi. Active development is done in the develop branch with release version merged into master

Example Usage

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.data[0]['cid']

# create a sub-channel
server.send_command('channelcreate', keys={'channel_name': 'Just some sub-channel', 'cpid': channel_id})

python-ts3's People

Contributors

Stargazers

Watchers

Forkers

kjagiello caiges lukegb hiciu ajurna vasher tosta-mista zombietoof psykzz ryanbentley apollofortynine volody2006 martinbacon adarnof xnicram jowrjowr ofirgall

python-ts3's Issues

TypeError: unsupported operand type(s) for %: 'bytes' and 'bytes'

hello,

am trying to test this API but am stuck with this error full output:

D:\DEV\py341\python.exe D:/DEV/workspace/py/hellow/main.py
Traceback (most recent call last):
File "D:/DEV/workspace/py/hellow/main.py", line 4, in
server.login('user', 'pass')
File "D:\DEV\py341\lib\site-packages\python_ts3-0.1-py3.4.egg\ts3\server.py", line 64, in login
File "D:\DEV\py341\lib\site-packages\python_ts3-0.1-py3.4.egg\ts3\protocol.py", line 129, in send_command
TypeError: unsupported operand type(s) for %: 'bytes' and 'bytes'

Process finished with exit code 1

Feature Request: Error Handler

Would it be possible to have some type of Exception type that parses the response. In the event of a "error", make it available?

Thanks,

Notify implementation

I suggest to add a way to register server notifications and handle them.

Create documentation

Sphynx documentation set for the core of the library.

Release 0.2

PyPi has v0.1, which is very old and contains a few breaking bugs and race conditions for I/O. A new release needs to be produced and pushed to PyPi.

Allow for real TS3 server to be provided for testing

At the moment the library mocks a basic TS3 server for dumb testing, we should allow a real TS3 server connection details to be passed to allow a full library test against new TS3 versions.

Enable connections with server password

Well nvm. Missunderstood something

Pypi build has syntax error on py2

File "ts3/commands.py", line 79
def banadd(self, *, ip=None, name=None, uid=None, time=None, banreason=None):
                  ^
SyntaxError: invalid syntax

On connection fail, make error message available

If you get banned by the server, it would be nice to be able to get the error message.

Example:
$ telnet somehost 10011 Trying 1.2.3.4... Connected to somehost. Escape character is '^]'. TS3 Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command. error id=3329 msg=connection\sfailed,\syou\sare\sbanned extra_msg=you\smay\sretry\sin\s226\sseconds\n\rConnection closed by foreign host.

Update tests to take into account unordered dicts

As we use dicts for passing keys into the commands we can't be assured of the order that they keys are parsed out

https://travis-ci.org/nikdoof/python-ts3/jobs/21664169

While this isn't a failure of the output (as the command line is still valid) it will cause tests to fail intermittently.