Because the world needs yet another HTML templating framework
Project description
ZHTML (LGPLv3)
Because the world needs another HTML framework.
ZHTML is short for ZacHTML, which is short for Zach HTML.
ZHTML is intended for the server-side rendering of static web pages.
Install
python -m pip install zhtml
Tutorial
Create a blank HTML page to begin.
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<title>zhtml Example</title>
<!-- Water.css, to spruce things up -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">
</head>
<body>
</body>
</html>
ZHTML is intended for server-side rendering, so page elements are generated dynamically. As such, instead of putting our HTML directly into our file, we will instead insert a comment as a placeholder. This instructs the ZHTML engine where to insert the desired page elements.
</head>
<body>
<!-- APP -->
</body>
</html>
Next, let's begin our script.
# example.py
import zhtml as html
if __name__ == '__main__':
with open('examples/example.html', 'r') as example_file:
example = html.Page(example_file.read(), 'index')
html.Page allows us to load our template file as an object.
Before going any further, we need to bind our APP placeholder, using the html.Placeholder class.
# example.py
import zhtml as html
if __name__ == '__main__':
binding = html.Placeholder('APP')
with open('examples/example.html', 'r') as example_file:
example = html.Page(example_file.read(), 'index')
By passing 'APP' to our Placeholder object, we are telling it to look for the <!-- APP --> placeholder in our HTML file. The resulting object is an re.Pattern.
Next, let's create some HTML to inject into our example.html page.
ZHTML uses string functions to assemble HTML snippets. To start, let's create a heading and a paragraph.
# example.py
import zhtml as html
if __name__ == '__main__':
binding = html.Placeholder.create('APP')
with open('examples/example.html', 'r') as example_file:
example = html.Page(example_file.read(), 'index')
heading = html.heading('Hello, World!')
paragraph = html.paragraph('This is a body of text.')
Once created, lets wrap our new elements in a main tag. This will be the root of our application. Because ZHTML assembles elements as strings, unioning our heading and paragraph is as easy as concatenating two strings.
# example.py
import zhtml as html
if __name__ == '__main__':
binding = html.Placeholder.create('APP')
with open('examples/example.html', 'r') as example_file:
example = html.Page(example_file.read(), 'index')
heading = html.heading('Hello, World!')
paragraph = html.paragraph('This is a body of text.')
main = html.main(heading + paragraph)
Finally, we can inject our application using the inject_text method on our Page object. Be sure to provide the Placeholder that we created earlier. To output the results, use the write method.
# example.py
import zhtml as html
if __name__ == '__main__':
binding = html.Placeholder.create('APP')
with open('examples/example.html', 'r') as example_file:
example = html.Page(example_file.read(), 'index')
heading = html.heading('Hello, World!')
paragraph = html.paragraph('This is a body of text.')
main = html.main(heading + paragraph)
example = example.inject_text(main, binding)
example.write('output')
You should now have a file named index.html in the output folder of your project.
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<title>zhtml Example</title>
<!-- Water.css, to spruce things up -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">
</head>
<body>
<main>
<h1>Hello, World!</h1>
<p>This is a body of text.</p>
</main>
</body>
</html>
Contributing
ZHTML is a young project, with a lot of work to do. If you want to help contact z3c0, or fork the project and submit your change as a merge request.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file zhtml-1.1.0-py3-none-any.whl.
File metadata
- Download URL: zhtml-1.1.0-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bbeb15a497eed7aef3eb6b55dd82c4e4aa3c1727f5884a12a21e6fe0adfc7122 |
|
| MD5 | ffa0830d92b285e5dcee8fce9d9ceac1 |
|
| BLAKE2b-256 | 849e59249362710c5c125cf930f0c29315776d7566b9b0f9a8f1b39541a8b581 |
