Web HTML maker in Python - a light web application framework
Project description
WhakerPy - a Web HTML maker in Python
Overview
WhakerPy is an open source library to create dynamic HTML content; it's a light web application framework.
Create and manipulate HTML from the power of Python:
- Easy to learn, consistent, simple syntax.
- Flexible and easy usage.
- Create HTML pages dynamically.
- Can save as static files, and/or
- Run locally with its HTTPD server and response "bakery" system.
Not enough? Install https://whakerexa.sf.net too, an extension for WhakerPy. It includes useful CSS frameworks, JavaScripts, and Python classes for a stylized static or dynamic content.
License
WhakerPy is under the terms of the GNU General Public License version 3.
Install WhakerPy
From pypi.org:
> python -m pip install WhakerPy
From its wheel package:
Download the wheel file (WhakerPy-xxx.whl) and install it in your python environment with:
> python -m pip install dist/<WhakerPy-xxx.whl>
From its repo:
Download the repository and unpack it, or clone with git. Optionally, it can be installed with:
> python -m pip install .
Install all the optional dependencies with:
> python -m pip install ".[doc, dev, test]"
WhakerPy package includes the following folders and files:
- "whakerpy": the source code package
- "docs": the documentation of whakerpy library in HTML and Markdown
- "sample": a webapp sample
- "tests": the tests of the source code
Quick Start
Open a Python interpreter and type or paste the following:
>>> from whakerpy.htmlmaker import HTMLTree
>>> from whakerpy.htmlmaker import HTMLNode
>>> htree = HTMLTree("index")
>>> node = HTMLNode(htree.body_main.identifier, None, "h1", value="this is a title")
>>> htree.body_main.append_child(node)
Render and print the HTML:
>>> print(htree.serialize())
<!DOCTYPE html>
<html>
<head> </head>
<body>
<main>
<h1>
this is a title
</h1>
</main>
</body>
</html>
Add some styling and others:
>>> htree.head.title("WhakerPy")
>>> htree.head.meta({"charset": "utf-8"})
>>> htree.head.link(rel="icon", href="/static/favicon.ico")
>>> htree.head.link(rel="stylesheet", href="nice.css", link_type="text/css")
Add page copyright in the footer:
>>> copyreg = HTMLNode(htree.body_footer.identifier, "copyright", "p",
>>> attributes={"class": "copyright", "role": "none"},
>>> value="Copyright © 2023 My Self")
>>> htree.body_footer.append_child(copyreg)
Let's view the result in your favorite web browser:
>>> import webbrowser
>>> file_whakerpy = htree.serialize_to_file('file.html')
>>> webbrowser.open_new_tab(file_whakerpy)
Create a web application frontend with dynamic HTML content
For a quick start, see the file sample.py in the repo. It shows a very simple solution to create a server that can handle dynamic content. This content is created from a custom BaseResponseRecipe() object, available in the file samples/response.py. The response is the interface between a local back-end python application and the web front-end.
For a more complex example of an already in-used web frontend, see: https://sourceforge.net/p/sppas/code/ci/master/tree/sppas/ui/swapp/app_setup/setupmaker.py.
Projects using WhakerPy
WhakerPy was initially developed within SPPAS https://sppas.org; it was extracted from its original software by the author to lead its own life as standalone package. The "setup" of SPPAS is entirely based on whakerpy API.
Other projects:
- the website https://auto-cuedspeech.org is entirely based on WhakerPy.
- the website https://sppas.org is entirely based on WhakerPy.
- contact the author if your project is using WhakerPy
The developer's corner
Create a wheel
WhakerPy is no system dependent. Information to build its wheel are stored into the file pyproject.toml.
The universal wheel is created with: python -m build
Make the doc
The API documentation is available in the doc folder. Click the file index.html to browse throw the documented classes.
To re-generate the doc, install the required external program, then launch the doc generator:
>python -m pip install ".[docs]"
>python makedoc.py
Test/Analyze source code
Code coverage can be analyzed with unittest and coverage.
Install them with the command: python -m pip install ".[test]".
Then, perform the following steps:
coverage run -m unittestcoverage reportto see a summary report into the terminal, or use this command to get the result in XML format:coverage xml
The whakerpy package can be analyzed with SonarQube by following these steps:
- Download and install Docker
- Download and install SonarQube:
docker pull sonarqube:latest - Start the SonarQube server:
docker run --stop-timeout 3600 -d --name sonarqube -p 9000:9000 sonarqube:latestLog in to http://localhost:9000. Both login and password are "admin".
Add the python plugin and restart server. - Click "Add project" with name "WhakerPy", and provide it a token
- Download sonar-scanner client. On macOS its:
brew install sonar-scanner. - Launch:
sonar-scanner -Dsonar.tokan="paste the token here" - See results in the opened URL. You may not forget that it's an automatic code analyzer, not an intelligent one.
How to contribute
If you plan to contribute to the code, please send an e-mail to the author.
Author/Copyright
Copyright (C) 2023-2024 - Brigitte Bigi - contact@sppas.org, Laboratoire Parole et Langage, Aix-en-Provence, France.
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 WhakerPy-0.5-py3-none-any.whl.
File metadata
- Download URL: WhakerPy-0.5-py3-none-any.whl
- Upload date:
- Size: 76.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3974621024a81719fc67b50bdd4633d15c6d25dc2d341f616aea841f299cb65f |
|
| MD5 | 3485cf5b37ced85f8baed8a6a6d0a7e4 |
|
| BLAKE2b-256 | bb5e60fddd73829a01f6bcff798a9aff427bfaade2e44d56a6adfd4acfb0f118 |
