PyWebIO
Write interactive web app in script way.
[Document] | [Demos] | [Why PyWebIO?]
PyWebIO provides a series of imperative functions to obtain user input and output on the browser, turning the browser into a "rich text terminal", and can be used to build simple web applications or browser-based GUI applications without the need to have knowledge of HTML and JS. PyWebIO can also be easily integrated into existing Web services. PyWebIO is very suitable for quickly building applications that do not require complex UI.
Features：
- Use synchronization instead of a callback-based method to get input
- Non-declarative layout, simple and efficient
- Less intrusive: old script code can be transformed into a Web application only by modifying the input and output operation
- Support integration into existing web services, currently supports Flask, Django, Tornado, aiohttp, FastAPI framework
- Support for
asyncioand coroutine - Support data visualization with third-party libraries, e.g.,
plotly,bokeh,pyecharts.
Installation
Stable version:
pip3 install -U pywebio
Development version:
pip3 install -U https://code.aliyun.com/wang0618/pywebio/repository/archive.zip
Prerequisites: PyWebIO requires Python 3.5.2 or newer
Quickstart
Hello, world
Here is a simple PyWebIO script to calculate the BMI:
from pywebio.input import input, FLOAT
from pywebio.output import put_text
def bmi():
height = input("Your Height(cm)：", type=FLOAT)
weight = input("Your Weight(kg)：", type=FLOAT)
BMI = weight / (height / 100) ** 2
top_status = [(14.9, 'Severely underweight'), (18.4, 'Underweight'),
(22.9, 'Normal'), (27.5, 'Overweight'),
(40.0, 'Moderately obese'), (float('inf'), 'Severely obese')]
for top, status in top_status:
if BMI <= top:
put_text('Your BMI: %.1f, category: %s' % (BMI, status))
break
if __name__ == '__main__':
bmi()
This is just a very simple script if you ignore PyWebIO, but using the input and output functions provided by PyWebIO, you can interact with the code in the browser [demo]:
Serve as web service
The above BMI program will exit immediately after the calculation, you can use pywebio.start_server() to publish the bmi() function as a web application:
from pywebio import start_server
from pywebio.input import input, FLOAT
from pywebio.output import put_text
def bmi(): # bmi() keep the same
...
if __name__ == '__main__':
start_server(bmi, port=80)
Integration with web framework
To integrate a PyWebIO application into Tornado, all you need is to add a RequestHandler to the existing Tornado application:
import tornado.ioloop
import tornado.web
from pywebio.platform.tornado import webio_handler
class MainHandler(tornado.web.RequestHandler):
def get(self):
self.write("Hello, world")
if __name__ == "__main__":
application = tornado.web.Application([
(r"/", MainHandler),
(r"/bmi", webio_handler(bmi)), # bmi is the same function as above
])
application.listen(port=80, address='localhost')
tornado.ioloop.IOLoop.current().start()
Now, you can open http://localhost/bmi for BMI calculation.
For integration with other web frameworks, please refer to document.
Demos
- Basic demo : PyWebIO basic input and output demos and some small applications written using PyWebIO.
- Data visualization demo : Data visualization with the third-party libraries, e.g.,
plotly,bokeh,pyecharts.
Document
Document is on https://pywebio.readthedocs.io
![[feature request] auto-load app when running the app, and auto-refresh when changing the code](https://avatars.githubusercontent.com/u/39755678?v=4)
![[Feature Request] start_scriptmode server function](https://avatars.githubusercontent.com/u/15276246?v=4)
1 Jan 15, 2022
6 Nov 7, 2022
55 Jan 5, 2023
11 Oct 7, 2022
12 May 14, 2022
2 Sep 11, 2022
41 Dec 1, 2022
1 Dec 13, 2021
6 Nov 1, 2022
1 Jan 9, 2022
1 Feb 3, 2022
10 Dec 10, 2022
2 Mar 1, 2022
1.8k Jan 3, 2023
17.1k Jan 8, 2023
3 Nov 13, 2021
111 Jan 7, 2023
9 Jul 13, 2022
2 Jun 22, 2022