flask-socketio-lit-html 0.1.0rc5

Simple Webcomponents with flask

Flask-Socket.IO-lit-html

Webcomponents with Flask and SocketIO

Proof of concept project to use Webcomponents in Python Flask

• Generate a restful API (inspired from Flask-Restful)
• Update html on data changes through socketio (Inspired from Angular properties reflection)

Usage philosophy

Create user webcomponent from sqlalchemy design:

class User(db.Model):
    username = db.Column(db.String(80), nullable=False)

blueprint = User.register("/user", "user-item", "user.html")
app.register_blueprint(blueprint)

Display the second user of your database:

<script type="module" src="{{url_for('user-item.webcomponent')}}"></script>
<div> user 2: <user-item index=2 ></user-item></div>

This code represent the idea behind the module, it's not real code, look at app.py for a working example.

Contribute : Pull requests are welcome !

Updating autodoc

cd docs && sphinx-apidoc -o source/ ../flask_socketio_lit_html

Build and publish package

poetry build

Just increment the version in pyproject.toml to publish after tests are succesfully passed (see .travis.yml)