Refactored for Cheese Shop

Author: Pithikos

README.md

@@ -8,9 +8,9 @@ A minimal Websockets Server in Python with no external dependencies.
   * Multiple clients
   * No dependencies
 
-Notice that this Websocket Server doesn't support the more advanced features
-like SSL etc. The main usage for this server is to include it in your program
-to be able and talk with the browser.
+Notice that this websocket-server doesn't support the more advanced features
+like SSL etc. The project is focused mainly on making it easy to run a
+websocket server for prototyping or testing.
 
 
 Usage
@@ -25,7 +25,7 @@ Then just open `client.html` in your browser and you should be able to send and
 Using on your project
 =======================
 In order to use the websocket server in your project, simply
-copy `websocket.py` to your project and `from websocket import WebSocketsServer`.
+copy `websocket.py` to your project and `from websocket import WebsocketServer`.
 Then use the documented API below to manage the behaviour of your server.
 
 By default the server doesn't do anything when events occur.
@@ -34,11 +34,11 @@ By default the server doesn't do anything when events occur.
 API
 =======================
 
-The API is simply methods and properties of a `WebSocketsServer` instance.
+The API is simply methods and properties of a `WebsocketServer` instance.
 
-## WebSocketsServer
+## WebsocketServer
 
-The WebSocketsServer takes two arguments: a `port` and a `hostname`.
+The WebsocketServer takes two arguments: a `port` and a `hostname`.
 By default `localhost` is used. However if you want to be able and connect
 to the server from the network you need to pass `0.0.0.0` as hostname.
 
@@ -75,12 +75,12 @@ passed in case you want to send messages to clients.
 
 Example:
 ````
-from websocket import WebSocketsServer
+from websocket_server import WebsocketServer
 
 def new_client(client, server):
 	server.send_message_to_all("Hey all, a new client has joined us")
 
-server = WebSocketsServer(13254)
+server = WebsocketServer(13254)
 server.set_fn_new_client(new_client)
 server.run_forever()
 ````

client.html

@@ -9,7 +9,7 @@
     function init() {
 
       // Connect to Web Socket
-      ws = new WebSocket("ws://localhost:13254/");
+      ws = new WebSocket("ws://localhost:9001/");
 
       // Set event handlers.
       ws.onopen = function() {

python_websockets/__init__.py

@@ -1,5 +1,5 @@
-from python_websockets.websocket import WebSocketsServer
-
+#from python_websockets.websocket import WebSocketsServer
+from websocket_server import WebsocketServer
 
 # Called for every client connecting (after handshake)
 def new_client(client, server):
@@ -20,7 +20,7 @@ def message_received(client, server, message):
 
 
 PORT=9001
-server = WebSocketsServer(PORT)
+server = WebsocketServer(PORT)
 server.set_fn_new_client(new_client)
 server.set_fn_client_left(client_left)
 server.set_fn_message_received(message_received)

python_websockets/websocket.pyc

@@ -4,12 +4,12 @@
     name='websocket_server',
     version='0.4',
     packages=find_packages("."),
-    url='https://github.com/Pithikos/python-%3Cspan%20class="x x-first x-last">websockets-server',
+    url='https://github.com/Pithikos/python-%3Cspan%20class="x x-first x-last">websocket-server',
     license='MIT',
     author='Johan Hanssen Seferidis',
-    author_email='test@example.com',
+    author_email='manossef@gmail.com',
     install_requires=[
     ],
-    description='A simple fully working WebsocketsServer in Python (with no dependencies)',
+    description='A simple fully working websocket-server in Python with no external dependencies',
     platforms='any',
 )

server.py

@@ -0,0 +1 @@
+from .websocket_server import *

setup.py

@@ -76,7 +76,7 @@ def send_message_to_all(self, msg):
 
 # ------------------------- Implementation -----------------------------
 
-class WebSocketsServer(ThreadingMixIn, TCPServer, API):
+class WebsocketServer(ThreadingMixIn, TCPServer, API):
 
 	allow_reuse_address = True
 	daemon_threads = True # comment to keep threads alive until finished