obmarg / chunnel

A python client for phoenix channels.

Chunnel

A python client for phoenix channels.

Usage

from chunnel import Socket

socket = Socket('ws://example.com/socket', params={'token': 'blah'})
async with socket:
    channel = socket.channel('room:lobby, {})
    await channel.join()
    incoming = await channel.receive()
    await incoming.reply({'blah': 'whatever'})
    msg = await channel.push('something', {})
    response = await msg.response()

Status

Chunnel is very much in alpha status right now. It's API can (and probably will) change, there's many edge cases that are not currently handled, and many TODOs littered about the code.

Currently implemented:

• Joining channels
• Receving messages
• Sending messages

Not implemented:

• Documentation
• Incoming channel leave messages
• Connection errors/reconnecting.
• Much other error handling
• Presence
• Probably other things

Pull requests welcome.

Thanks

Some thanks to:

• @ChaseGilliam on Twitter for the name.
• Various others for suggestions.

chunnel's Issues

Missing license

Hey there! I'd like fork this repo and build something with it, but there's no license, so I hesitated. Do you mind adding one? Thanks!

is this still relevant?

trying with your api, but seems like it's not relevant anymore. Has anyone tried this recently?

Binary response breaks join

Hi
I am trying to use chunnel for connecting to a pheonix channel, but the server responds with a binary response instead of a json when join request is sent. what am I doing wrong? the response is not a proper json and chunnel breaks on channel join.
I took the url and parameters from the website that implemented the channel connection in react.