Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Django package for socket.io via nodejs

Project description

### What is django-socketio-events?

Simply adds socket.io functionality to Django applications by proxying Django behind a Nodejs/SocketIO server.

Any callback function defined in an `app_folder` is exposed to Socket.IO as the target `my_app.callback_fn`. See examples below.

### Usage

```
python manage.py runserverjs <hostname> <public port> <proxy port> <socket port>
```

In any Django template that you want a Socket IO connection, add this templatetag to your HEAD:

```
{% load nodjango %}
<!doctype html>
<html>
<head>
<script type="text/javascript" src="//code.jquery.com/jquery-2.1.1.min.js"></script>
{% socketio_head_scripts %}
</head>
<body>
<button>Click Me</button>
<script type="text/javascript">
socket.on('my_callback', function(data){
console.log(JSON.stringify(data));
});

$('button').on('click', function(){
socket.emit('django', {
'event': 'my_app.change_color',
'callback': 'my_callback',
'color': 'red'
});
});
</script>
</body>
</html>
```

```
# my_app/socketio.py

def change_color(color):
# change color
# ...
# profit
return {'result': 42}
```

### Installation

```
pip install django-socketio-events
```

And then add `nodjango` to your `INSTALLED_APPS`.

### Under the hood

* [virtual-node](https://github.com/elbaschid/virtual-node) for installing [node.js](http://nodejs.org/) in a Python virtualenv.
* [Django](https://www.djangoproject.com/) web framework

Project details


Release history Release notifications

Download files

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

Files for django-socketio-events, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size django-socketio-events-0.1.2.tar.gz (30.4 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page