Refactor into python modules: websocket, websocketproxy

Make websockify subdirectory and move websocket.py ->
websockify/websocket.py and websockify ->
websockify/websocketproxy.py. Create a ./run script that launches
websockify as before (unfortunately can't have a websockify script at
the same level since this is now a directory). Make websockify.py
a symlink to ./run. Once the package is installed, the main launch
script will be /usr/bin/websockify.

This makes it easier to package up websockify as a python module.
setup.py should now properly install websockify as a module.

Note that to include the base websocket module/class you will now do:

    import websockify.websocket
    #OR
    from websockify.websocket import WebSocketServer

To import the full websocket proxy functionality:

    import websockify.websocketproxy
    #OR
    from websockify.websocket import WebSocketProxy

This will also help with startup speed slightly because the code in
websocketproxy will now be byte compiled since it is no longer in the
main invocation script.
This commit is contained in:
Joel Martin 2012-09-17 14:06:51 -05:00
parent 2d2798954e
commit c0d23e27e4
6 changed files with 9 additions and 3 deletions

5
run Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/python
import websockify
websockify.websocketproxy.websockify_init()

View File

@ -18,13 +18,13 @@ setup(name=name,
author="Joel Martin",
author_email="github@martintribe.org",
packages=find_packages(),
packages=['websockify'],
include_package_data=True,
install_requires=['numpy'],
zip_safe=False,
entry_points={
'console_scripts': [
'websockify = websockify:websockify_init',
'websockify = websockify.websocketproxy:websockify_init',
]
},
)

View File

@ -1 +1 @@
websockify
run

1
websockify/__init__.py Normal file
View File

@ -0,0 +1 @@
import websocket, websocketproxy