Skip to content

Commit

Permalink
Merge 3134705 into 9bf5a59
Browse files Browse the repository at this point in the history
  • Loading branch information
Relrin committed Dec 1, 2016
2 parents 9bf5a59 + 3134705 commit bb94fe1
Show file tree
Hide file tree
Showing 8 changed files with 716 additions and 39 deletions.
16 changes: 8 additions & 8 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Project Leader:

- Valeryi Savich <relrin78@gmail.com>

Contributors of code for aiorest-ws are:
Contributors:

- Dmitry Vechorko <vechorkodima@gmail.com>

The serializers, field classes and exception style was taken from the Django
REST Framework. The original code is BSD licensed. The following copyrights
apply:
The serializers, field, exception classes and documentation for them was
taken from the Django REST Framework. The original code is BSD licensed. The
following copyrights apply:

- (c) 2015 Tom Christie
- (c) 2016 Tom Christie

The to_xml() function was taken from the django-rest-framework-xml module.
The original code is BSD licensed with the following copyrights from that
Expand All @@ -24,21 +24,21 @@ module:
The routing classes and URL parser code originally placed in aiohttp library.
The original code is Apache 2.0 licensed. The following copyrights apply:

- (c) 2015 Andrew Svetlov <andrew.svetlov@gmail.com>
- (c) 2016 Andrew Svetlov <andrew.svetlov@gmail.com>

The View, MethodViewMeta, MethodBasedView classes are partly modified,
and the base implementation was taken from the Flask project (views module).
The original code is BSD licensed with the following copyrights from
that module:

- (c) 2015 Armin Ronacher <armin.ronacher@active-4.com>
- (c) 2016 Armin Ronacher <armin.ronacher@active-4.com>

The idea for the "global" settings with further overriding, some util modules
for processing requests and accessing to fields was taken from the Django
Framework. The original code is BSD licensed with the following copyrights
from that module:

- (c) 2015 Django Software Foundation
- (c) 2016 Django Software Foundation

The nice_repr (renamed to humanize_timedelta), iso8601_repr and parse
(renamed to parse_timedelta) functions for processing timedelta objects and
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Features

Requirements
-----
- Python >= 3.4.0
- Autobahn.ws >= 0.12.1
- Python >= 3.4.2
- Autobahn.ws == 0.16.0

Optional:
- SQLAlchemy ORM >= 1.0
Expand Down Expand Up @@ -54,8 +54,7 @@ Getting started
var ws = null;
var isopen = false;

window.onload = function()
{
window.onload = function() {
ws = new WebSocket("ws://127.0.0.1:8080");
ws.onopen = function() {
console.log("Connected!");
Expand Down Expand Up @@ -103,7 +102,7 @@ class HelloClientProtocol(WebSocketClientProtocol):


if __name__ == '__main__':
factory = WebSocketClientFactory("ws://localhost:8080", debug=False)
factory = WebSocketClientFactory("ws://localhost:8080")
factory.protocol = HelloClientProtocol

loop = asyncio.get_event_loop()
Expand Down
2 changes: 1 addition & 1 deletion aiorest_ws/db/orm/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from aiorest_ws.exceptions import ImproperlyConfigured
from aiorest_ws.db.orm.abstract import AbstractSerializer, AbstractField, \
empty, SkipField
from aiorest_ws.db.orm.fields import HiddenField
from aiorest_ws.db.orm.fields import * # NOQA
from aiorest_ws.db.orm.exceptions import ValidationError
from aiorest_ws.utils.fields import set_value, get_attribute
from aiorest_ws.utils.functional import cached_property
Expand Down
1 change: 0 additions & 1 deletion docs/source/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ handler. It can be method-based:
from aiorest_ws.views import MethodBasedView
class HelloWorld(MethodBasedView):
def get(self, request, *args, **kwargs):
return "Hello, world!"
Expand Down
9 changes: 5 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@

# General information about the project.
project = 'aiorest-ws'
copyright = '2015, Valeryi Savich'
copyright = '2016, Valeryi Savich'
author = 'Valeryi Savich'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
version = '1.1'
# The full version, including alpha/beta/rc tags.
release = '1.0'
release = '1.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -136,6 +136,7 @@
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'logo': 'logo.png',
'description': 'REST framework with WebSockets support',

'github_user': 'Relrin',
Expand Down Expand Up @@ -172,7 +173,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['static', ]

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
11 changes: 5 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Features
- Authentication (using JSON Web Token)
- Customizing behaviour of your application through settings file
- Compressing messages for minimize of transmitted traffic (if your browser support)
- Model serializing for Django and SQLAlchemy ORM
- SSL support

Library installation
Expand All @@ -43,8 +44,7 @@ Client example (JavaScript):
var ws = null;
var isopen = false;
window.onload = function()
{
window.onload = function() {
ws = new WebSocket("ws://127.0.0.1:8080");
ws.onopen = function() {
console.log("Connected!");
Expand Down Expand Up @@ -80,7 +80,6 @@ Client example (Python):
from autobahn.asyncio.websocket import WebSocketClientProtocol, \
WebSocketClientFactory
class HelloClientProtocol(WebSocketClientProtocol):
def onOpen(self):
Expand All @@ -93,7 +92,7 @@ Client example (Python):
if __name__ == '__main__':
factory = WebSocketClientFactory("ws://localhost:8080", debug=False)
factory = WebSocketClientFactory("ws://localhost:8080")
factory.protocol = HelloClientProtocol
loop = asyncio.get_event_loop()
Expand Down Expand Up @@ -157,15 +156,15 @@ Contents:
---------

.. toctree::
:maxdepth: 2
:maxdepth: 4

auth
app
request
routing
serializing
wrappers
views
api

Indices and tables
==================
Expand Down
Loading

0 comments on commit bb94fe1

Please sign in to comment.