Skip to main content

Make interactive web apps using good ol' HTML, CSS and a sprinkling of JavaScript — in Python.

Project description

MakeWeb

Make interactive web apps using good ol' HTML, CSS and a sprinkling of JavaScript — in Python.

Examples

HyperText Markup Lnguage

If we run this script:

# 00-generate-html.py

from makeweb import Doc, body, h1

def generate_html():
    doc = Doc('html', lang='mr')
    with body():
        h1('हा!')
    return str(doc)

print(generate_html())

We should see this output on the screen:

<!doctype html>
<html lang="mr">
<body>
  <h1>हा!</h1>
</body>
</html>

(Whitespace added for clarity.)

Ha! HTML was easy, let us generate CSS from Python code.

Cascading Style Sheets

# 01-generate-css.py

from makeweb import CSS

css = CSS()

css('body', background='white', color='#222')
css('h1', color='darkorange', margin__top='1em')

print(str(css))

Running the above example we see...

body{
  background:white;
  color:#222
}
h1{
  color:darkorange;
  margin-top:1em
}

(Whitespace added for clarity.)

Notice that the double underscore in css('h1', margin__top='1em') gets converted to hyphen in CSS as h1{margin-top:1em}. This pattern is used throughout the library for HTML and CSS attributes.

So... CSS is even easier?! How about something more ambitious?

JavaScript

# 02-generate-js.py

from makeweb import JS

js = JS()

@js.function
def say_hello():
    hello_box = document.getElementById("hello_box")
    hello_box.innerHTML = "Hello, World Wide Web!"

print(str(js))

And we get a JavaScript function out!

function say_hello(){
  var hello_box;
  hello_box=document.getElementById("hello_box");
  hello_box.innerHTML="Hello, World Wide Web!";
}

(Whitespace added for clarity.)

Now let us use these capabilities together!

App

# hello-readme.py

from flask import Flask, Response
from makeweb import (
    Doc, CSS, JS,
    head, title, style, script,
    body, h1, button,
)

# We'll use Flask to serve, you could use any other framework 
# or save as static files, or anything else 
# that you wish to do with generated html.
app = Flask(__name__)  
css = CSS()
js = JS()

css('*,body',   # <-- Add CSS to taste.
    font__family='sans-serif',
    text__align='center')
css('h1', color="darkblue")  


@js.function  # <-- A sprinkling of JavaScript. Look ma, no braces!
def say_hello():
    hello_box = document.getElementById("hello_box")
    hello_box.innerHTML = "Hello, World Wide Web!"


@app.route('/')
def index():
    doc = Doc('html')  # <-- Generate all the HTML your app (really) needs.
    with head():
        title('Hello')
        with style():  # Embed CSS.
            css.embed()
    with body():
        h1('...', id='hello_box')  # Set attributes. 
        button('Hello', onclick="say_hello()")  # <-- hook up say_hello().
        with script():  # Embed JavaScript.
            js.embed()
    return Response(str(doc))  # <-- Serve all the awesome your users desire!


app.run()  # <-- It is time! 

This app transfers ~550 bytes over the network in order to run successfully, that is including the HTTP headers overhead. You read that right, not even one kilobyte! The web technologies are quite simple and straightforward for general use, and very flexible, robust and powerful too!

You might not need (or want the baggage of) complex tooling for a small project. It could be a one time make-and-forget tool at work or a weekend hobby project, or maybe something even larger if you really like this way of working. MakeWeb can come in handy because it makes it almost trivial to build the web like it was intended, straight from your Python code.

Wait, somebody mentioned single-page-apps? How about single source-file apps that don't download half the internet to work? 😂 Kidding, this is a very, very barebones system, and therefore you can use any existing stylesheets or JS libraries alongside MakeWeb.

Check out examples for more demos!

Install

Using Poetry (Recommended)

# Clone the repository
git clone https://github.com/hiway/makeweb.git
cd makeweb

# Install poetry if you haven't already
pip install poetry

# Install makeweb with JS support
poetry install --with js

# For development
poetry install --with dev

# For running examples
poetry install --with examples

# For everything
poetry install --with dev,js,examples

Using pip (Legacy)

Stable

python3 -m venv makeweb
source makeweb/bin/activate
pip install makeweb[js]

Current

python3 -m venv makeweb
source makeweb/bin/activate
git clone https://github.com/hiway/makeweb.git
cd makeweb
pip install -e .[examples]

Development

python3 -m venv makeweb
source makeweb/bin/activate
git clone https://github.com/hiway/makeweb.git
cd makeweb
pip install -e .[dev]
  • libtidy-dev

Test

pytest tests.py

With coverage:

pytest --cov=makeweb --cov-report=term tests.py

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

makeweb-0.2.3.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

makeweb-0.2.3-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file makeweb-0.2.3.tar.gz.

File metadata

  • Download URL: makeweb-0.2.3.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-51-generic

File hashes

Hashes for makeweb-0.2.3.tar.gz
Algorithm Hash digest
SHA256 bb6d141234af95425535c8ecc67806d3f061b3b414e2f99dacd18693d77e6720
MD5 493aae2d541e0b848f6bccd065eabb88
BLAKE2b-256 c774ac2bb3b8bda4b956e25dd2e8ef6ae1d8d71a7b8030f3b1826334a73833e6

See more details on using hashes here.

File details

Details for the file makeweb-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: makeweb-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-51-generic

File hashes

Hashes for makeweb-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3234fac95cbc2228008e172bc9dd84255295c731b8199f906ac0a566470776f5
MD5 b237630083608844e9845cead2a3aaab
BLAKE2b-256 e754eaa648082a977f03288c82f22e2505b58e876f699723d0de5601b5b9c07b

See more details on using hashes here.

Supported by

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