Releasing 1.1.0

This commit is contained in:
Andrew Godwin 2017-03-18 12:57:46 -07:00
parent 63dc5f6651
commit 08881bc7de
5 changed files with 42 additions and 12 deletions

View File

@ -1,6 +1,21 @@
Full release notes, with more details and upgrade information, are available at:
https://channels.readthedocs.io/en/latest/releases
1.1.0 (2017-03-18)
------------------
* Channels now includes a JavaScript wrapper that wraps reconnection and
multiplexing for you on the client side.
* Test classes have been moved from ``channels.tests`` to ``channels.test``.
* Bindings now support non-integer fields for primary keys on models.
* The ``enforce_ordering`` decorator no longer suffers a race condition where
it would drop messages under high load.
* ``runserver`` no longer errors if the ``staticfiles`` app is not enabled in Django.
1.0.3 (2017-02-01)
------------------

View File

@ -1,4 +1,4 @@
__version__ = "1.0.3"
__version__ = "1.1.0"
default_app_config = 'channels.apps.ChannelsConfig'
DEFAULT_CHANNEL_LAYER = 'default'

View File

@ -4,14 +4,24 @@ Channels WebSocket wrapper
Channels ships with a javascript WebSocket wrapper to help you connect to your websocket
and send/receive messages.
First, you must include the javascript library in your template::
First, you must include the javascript library in your template; if you're using
Django's staticfiles, this is as easy as::
{% load staticfiles %}
{% static "channels/js/websocketbridge.js" %}
If you are using an alternative method of serving static files, the compiled
source code is located at ``channels/static/channels/js/websocketbridge.js`` in
a Channels installation. We compile the file for you each release; it's ready
to serve as-is.
The library is deliberately quite low-level and generic; it's designed to
be compatible with any JavaScript code or framework, so you can build more
specific integration on top of it.
To process messages::
const webSocketBridge = new channels.WebSocketBridge();
webSocketBridge.connect();
webSocketBridge.listen(function(action, stream) {
@ -36,10 +46,9 @@ To demultiplex specific streams::
console.info(action, stream);
});
To send a message to a specific stream::
webSocketBridge.stream('mystream').send({prop1: 'value1', prop2: 'value1'})
The library is also available as npm module, under the name
The library is also available as a npm module, under the name
`django-channels <https://www.npmjs.com/package/django-channels>`_

View File

@ -1,27 +1,33 @@
1.1.0 Release Notes
===================
.. note::
The 1.1.0 release is still in development.
Channels 1.1.0 introduces a couple of major but backwards-compatible changes,
including most notably the inclusion of a standard, framework-agnostic JavaScript
library for easier integration with your site.
Channels 1.1.0 introduces a couple of major but backwards-compatible changes.
It was released on UNKNOWN.
Major Changes
-------------
* Channels now includes a JavaScript wrapper that wraps reconnection and
multiplexing for you on the client side. For more on how to use it, see the
:doc:`/javascript` documentation.
* Test classes have been moved from ``channels.tests`` to ``channels.test``
to better match Django. Old imports from ``channels.tests`` will continue to
work but will trigger a deprecation warning, and ``channels.tests`` will be
removed completely in version 1.3.
Minor Changes & Bugfixes
------------------------
* Bindings now support non-integer fields for primary keys on models
* Bindings now support non-integer fields for primary keys on models.
* The ``enforce_ordering`` decorator no longer suffers a race condition where
it would drop messages under high load
it would drop messages under high load.
* ``runserver`` no longer errors if the ``staticfiles`` app is not enabled in Django.
Backwards Incompatible Changes

View File

@ -1,6 +1,6 @@
{
"name": "django-channels",
"version": "0.0.2",
"version": "1.1.0",
"description": "",
"repository": {
"type": "git",