Skip to main content

Python binding for Tox the skype replacement

Project description

http://img.shields.io/travis/aitjcize/PyTox.svg http://img.shields.io/pypi/v/PyTox.svg http://img.shields.io/pypi/dm/PyTox.svg

PyTox

Python binding for Project Tox.

PyTox provides a Pythonic binding, i.e Object-oriented instead of C style, raise exception instead of returning error code. A simple example is as follows:

class EchoBot(Tox):
    def loop(self):
        while True:
            self.do()
            time.sleep(0.03)

    def on_friend_request(self, pk, message):
        print 'Friend request from %s: %s' % (pk, message)
        self.add_friend_norequest(pk)
        print 'Accepted.'

    def on_friend_message(self, friendId, message):
        name = self.get_name(friendId)
        print '%s: %s' % (name, message)
        print 'EchoBot: %s' % message
        self.send_message(friendId, message)

As you can see callbacks are mapped into class method instead of using it the the c ways. For more details please refer to examples/echo.py.

Getting started

To get started, a Makefile is provided to run PyTox inside a docker container:

  • make test: This will launch tests in a container.

  • make run: This will launch an interactive container with PyTox installed.

  • make echobot: This will launch the example echobot in a container.

Examples

  • echo.py: A working echo bot that wait for friend requests, and than start echoing anything that friend send.

Documentation

Full API documentation can be read here.

Todo

  • Complete API binding (use toos/apicomplete.py to check)

  • Unittest for ToxAV

Contributing

  1. Fork it

  2. Create your feature branch (git checkout -b my-new-feature)

  3. Commit your changes (git commit -am 'Add some feature')

  4. Push to the branch (git push origin my-new-feature)

  5. Create new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyTox-0.0.23.tar.gz (35.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page