Metadata-Version: 2.1
Name: WSocket
Version: 2.0.0.dev2
Summary: Simple WSGI Websocket Server, Framework, Middleware And App
Home-page: https://github.com/Ksengine/wsocket/
Author: Kavindu Santhusa
Author-email: kavindusanthusa@gmail.com
License: MIT
Project-URL: Bug Reports, https://github.com/Ksengine/wsocket/issues/
Project-URL: Documentation, https://wsocket.gitbook.io/
Project-URL: Source, https://github.com/Ksengine/wsocket/
Description: # <img src="https://github.com/Ksengine/WSocket/raw/master/assests/icon.png" width="30" height="30"> WSocket
        **Simple WSGI HTTP + Websocket Server, Framework, Middleware And App.**
        
        [![Downloads](https://pepy.tech/badge/wsocket)](https://pepy.tech/project/wsocket)
        
        **Note:**
        I am a 16 years old student.I have no enough knowledge. So can anyone [help me](https://github.com/Ksengine/WSocket/issues/2) to develop this library?
        ## Server
        Server([WSGI](http://www.wsgi.org/)) creates and listens at the HTTPsocket, dispatching the requests to a handler. WSGIRef server but uses threads to handle requests by using the ThreadingMixIn. This is useful to handle web browsers pre-opening sockets, on which Server would wait indefinitely.
        **can used with any WSGI compatible web framework**
        
        ## Middleware
        convert any WSGI compatible web framework to Websocket+HTTP framework
        using middleware.
        **works with many WSGI compatible servers**
        **can used with any WSGI compatible web framework**
        > Flask, Django, Pyramid, Bottle, ... supported
        
        ## Handler
        `wsgiref.simple_server.WSGIRequestHandler`  like class named `FixedHandler`  that always wrap WSGI app using Middleware.
        changes from `WSGIRequestHandler` :
        - Prevents reverse DNS lookups
        - errorless logger
        - use `ServerHandler`  to make it WSGI
        
        > You can convert wsgiref to a websocket+HTTP server using this handler
        
        ### ServerHandler
        `wsgiref.simple_server.ServerHandler`(inherited from `wsgiref.handlers.ServerHandler` like handler named `FixedServerHandler` .
        changes from `ServerHandler` :
        - set HTTP version to `1.1` because versions below `1.1` are not supported some clients like Firefox.
        - removed hop-by-hop headers checker because it raise errors on `Upgrade`  and `Connection` headers
        - check that all headers are strings
        
        ## Framework
        basic WSGI web application framework that uses Middleware.
        - simple routes handler
        - auto description to status code
        - headers checker
        - send data as soon as possible
        - send strings, bytes, lists(even bytes and strings mixed) or files directly 
        - error catcher and error logger
        
        **works with many WSGI compatible servers**
        
        ## App
        Event based app for websocket communication. this is app that uses Framework
        if not events handled by developer. this app works like demo(echo) app.
        
        ## Features
        all Middleware, Handler, Framework and App has following features.
        - websocket sub protocol supported
        - websocket message compression supported (works if client asks)
        - receive and send pong and ping messages(with automatic pong sender)
        - receive and send binary or text messages
        - works for messages with or without mask
        - closing messages supported
        - auto and manual close
        
        **View Documentaion** - https://wsocket.gitbook.io/
        **Report Bugs** - https://github.com/Ksengine/WSocket/issues/new/
        
        ### License
        Code and documentation are available according to the MIT License (see  [LICENSE](https://github.com/Ksengine/WSocket/blob/master/LICENSE)).
        
Keywords: http,websocket,wsgi,wsgiref,middleware,app,framework,server,handler
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.3
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: Stackless
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Description-Content-Type: text/markdown
