Skip to main content

Meld is a framework for Flask that allows you to create dynamic user interfaces using Python and the Jinja2 templating engine.

Project description


Project inspiration - Ditch Javascript Frameworks For Pure Python Joy

Join the community on Discord -

Meld is a framework for Flask to meld your frontend and backend code. What does that mean? It means you can enjoy writing dynamic user interfaces in pure Python.

Less context switching. No need to write javascript. More fun!

Initialize Meld in your project

For the sake of example, here is a minimal Flask application to get things running:

from flask import Flask, render_template
from flask_meld import Meld

app = Flask(__name__)
app.config['SECRET_KEY'] = 'big!secret'

meld = Meld()

socketio = app.socketio

def index():
    return render_template("base.html")

if __name__ == '__main__':, debug=True)

Add {% meld_scripts %} to your base html template

This sets up the application and initializes Flask-Meld.

<!DOCTYPE html>
        <title>Meld Example</title>
        <!-- Add the line below to include the necessary meld scripts-->
        {% meld_scripts %}

        {% block content %}
            <!-- Using a component in your template is easy! -->
            {% meld 'counter' %}
        {% endblock %}


Components are stored in meld/components either within your application folder or in the base directory of your project.

Components are simple Python classes.

The counter component:

# app/meld/components/

from flask_meld.component import Component

class Counter(Component):
    count = 0

    def add(self):
        self.count = int(self.count) + 1

    def subtract(self):
        self.count = int(self.count) - 1


Create a component template in templates/meld/counter.html. By creating a file within the templates/meld directory just include {% meld 'counter' %} where you want the component to load.

Here is an example for counter:

<!-- templates/meld/counter.html -->
    <button meld:click="subtract">-</button>
    <input type="text" meld:model="count" readonly></input>
    <button meld:click="add">+</button>

Let's take a look at that template file in more detail.

The buttons use meld:click to call the add or subtract function of the Counter component. The input uses meld:model to bind the input to the count property on the Counter component.

Form Validation

A big part of creating web applications is using forms. Flask-Meld integrates with Flask-WTF to give you real-time form validation without writing any Javascript.

Use WTForms for validation

Define your form with Flask-WTF just as you always do.

from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField
from wtforms.validators import DataRequired, Email, EqualTo

class RegistrationForm(FlaskForm):
    email = StringField('Email', validators=[DataRequired(), Email()])
    password = PasswordField('Password', validators=[DataRequired()])
    password_confirm = PasswordField('Confirm Password', validators=[DataRequired(), EqualTo('password')])

Create your template

Use WTForm helpers to create your form in your HTML template.

<!-- templates/meld/register.html -->
    <form method="POST">
            {{ }}
            {{ }}
            <span> {{ errors.password | first }} </span>

            {{ form.password.label }}
            {{ form.password }}
            <span> {{ errors.password | first }} </span>
            {{ form.password_confirm.label }}
            {{ form.password_confirm }}
            <span> {{ errors.password_confirm | first }} </span>
            {{ form.submit }}

Using the WTForm helpers saves you some typing. Alternatively, you can define your HTML form without using the helpers. For example, to make a field use <input id="email" meld:model="email" name="email" required="" type="text" value=""> Make sure that meld:model="name_of_field" exists on each field.

Define the form in the component

# meld/components/
from flask_meld import Component
from forms import RegistrationForm

class Register(Component):
    form = RegistrationForm()

Realtime form validation

To make your form validate as a user types use the updated function. This will provide the form field and allow you to validate on the fly. Simply call validate on the field.

# meld/components/
from flask_meld import Component
from forms import RegistrationForm

class Register(Component):
    form = RegistrationForm()

    def updated(self, field):

Your routes can stay the same when using real-time validation

You have options here, you can create a custom method on your component to handle submissions or you can use your regular old Flask routes.

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm()
    if form.validate_on_submit():
        # do anything you need with your form data...
        return redirect(url_for("index"))
    return render_template("register_page.html")

Pretty simple right? You can use this to create very dynamic user interfaces using pure Python and HTML. We would love to see what you have built using Meld so please share!

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Meld-0.4.3.tar.gz (36.9 kB view hashes)

Uploaded Source

Built Distribution

Flask_Meld-0.4.3-py3-none-any.whl (38.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page