Skip to main content

This is a package which was inspired by the annoyance of writing html strings when working with serving modules like flask.

pip install htmlhelpers

Basic usage

First, lets make some strings with basic html elements.

from htmlhelpers import htmlstring as hs

Create an html element:

hs.p("We love volleyball!")
# <p>We love volleyball!</p>

or one with attributes:

hs.p("We love volleyball!", attr_str='style="text-align:right"')
# <p style="text-align:right">We love volleyball!</p>

Or build a hierarchy:

hs.html(hs.p("Still love volleyball!"))
# <html><p>Still love volleyball!</p></html>

Build a list:

hs.ul("".join[hs.li("cats"), hs.li("dogs")])
# <ul><li>cats</li><li>dogs</li></ul>

Although once a list like that begins to grow, things can start to look a little messy. For more complex html expressions, we will be using the notion on a tag_series and a tag_phrase.

from htmlhelpers import htmlphrase as hp

Say we have a rappidly growing list. We can use a series to quickly create many of the same html elements in succession. We can use a tag_series.

list_of_animals = ["cats", "dogs", "rabbits"]
animals = hp.tag_series(hs.li, list_of_animals)
hs.ul(animals)
# <ul><li>cats</li><li>dogs</li><li>rabits</li></ul>

As the structure becomes deeper, we can further simplify our code with a tag_phrase.

hp.tag_phrase([hs.html, hs.div, hs.ul], animals)
# <html><div><ul><li>cats</li><li>dogs</li><li>rabits</li></ul></div></html>

Lastly, you can format the string in a much more human readable way, by setting the formatting=True in the tag_series function.

hp.tag_phrase([hs.html, hs.div, hs.ul], animals, formatting=True)
"""
<html>
  <div>
    <ul>
      <li>cats</li>
      <li>dogs</li>
      <li>rabits</li>
    </ul>
  </div>
</html>
"""

Optionally, you can pass one of these html phrase strings (any multilevel heirarchy) into the format_phrase function, found in htmlhelpers.htmlformat

Hope this helps at least a little! :)

Release files for htmlhelpers 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for htmlhelpers 0.1.1
File Size Uploaded
htmlhelpers-0.1.1.tar.gz 5.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for htmlhelpers 0.1.1
File Interpreter ABI Platform
htmlhelpers-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 11.6 kB

Release files / htmlhelpers-0.1.1.tar.gz

Download URL htmlhelpers-0.1.1.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
57ba307d72c190f53b1c329c8a7162200be337639de234d205a4f2820c391da3
BLAKE2b-256 checksum
How to use checksums
c38f06ef70e8543753c9f4843a44baf59b501893087f53e7f4e68fc8602fc491
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.10 CPython/3.7.3 Darwin/19.6.0

Release files / htmlhelpers-0.1.1-py3-none-any.whl

Download URL htmlhelpers-0.1.1-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5af996122509b1517ab6087f18a602415c116d75acda51aa6db4abade36dfd72
BLAKE2b-256 checksum
How to use checksums
72f2641b0d789072e3b219fc82bffda6fb6b960d27593548798ed7f356869eaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.10 CPython/3.7.3 Darwin/19.6.0

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page