Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ksenginew/wsocket
Simple WSGI HTTP + Websocket Server, Framework, Middleware And App.
https://github.com/ksenginew/wsocket
app framework handler http middleware python server single-file websocket wsgi wsgiref wsocket
Last synced: 3 months ago
JSON representation
Simple WSGI HTTP + Websocket Server, Framework, Middleware And App.
- Host: GitHub
- URL: https://github.com/ksenginew/wsocket
- Owner: ksenginew
- License: mit
- Created: 2020-06-23T07:24:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T10:52:46.000Z (6 months ago)
- Last Synced: 2024-10-11T19:51:19.617Z (4 months ago)
- Topics: app, framework, handler, http, middleware, python, server, single-file, websocket, wsgi, wsgiref, wsocket
- Language: Python
- Homepage: https://wsocket.gitbook.io/
- Size: 160 KB
- Stars: 25
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pepy.tech/project/wsocket)
[](https://github.com/Ksengine/WSocket/issues)
[](https://github.com/Ksengine/WSocket/network)
[](https://github.com/Ksengine/WSocket/stargazers)
[](https://github.com/Ksengine/WSocket/blob/master/LICENSE)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FKsengine%2FWSocket)
WSocket
Simple WSGI HTTP + Websocket Server, Framework, Middleware And App.
Explore the docs »
PyPI
·
Report Bug
·
Request Feature
## About The Project
This is a simple library to add websocket support to WSGI.
- Server - Patched wsgiref server
- Middleware - Add websocket support to Flask, Django, Pyramid, Bottle, ...
- Handler - Websocket handler to wsgiref
- Framework - Basic websocket + WSGI web application framework
- App - Plug and play demo app.
## Getting Started
This is an example of how you may give instructions on setting up your websocket connunication locally.
### Installation
You can
- Installing from PyPI
- Download:down_arrow: and Include
#### Installing from PyPI
Install latest version or upgrade an already installed WSocket to the latest from PyPI.
```bash
pip install --upgrade wsocket
```
#### Download and Include
- Visit [wsocket.py](https://raw.githubusercontent.com/Ksengine/WSocket/master/wsocket.py/).
- Save file (`ctrl+s` in browser).
- Include in your package derectory.
```
my-app/
├─ hello_world.py
├─ wsocket.py
```
## Usage
- Include following source on your test file(eg:-`hello_world.py`).
```python
from wsocket import WSocketApp, WebSocketError, logger, run
from time import sleep
logger.setLevel(10) # for debugging
def on_close(self, message, client):
print(repr(client) + " : " + message)
def on_connect(client):
print(repr(client) + " connected")
def on_message(message, client):
print(repr(clent) + " : " + repr(message))
try:
client.send("you said: " + message)
sleep(2)
client.send("you said: " + message)
except WebSocketError:
pass
app = WSocketApp()
app.onconnect += on_connect
app.onmessage += on_message
app.onclose += on_close
run(app)
```
- Visit [client.html](https://github.com/Ksengine/WSocket/raw/master/client.html).
- Save file (`ctrl+s` in browser).
- Open it in browser(websocket supported).
- Experience the two way websocket communication. :smile::smile::smile:
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Code and documentation are available according to the MIT License (see [LICENSE](https://github.com/Ksengine/WSocket/blob/master/LICENSE)).
## Contact
**Report Bugs** - https://github.com/Ksengine/WSocket/issues/new/