Skip to main content

Simple package that helps with creating html strings.

Project description

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! :)

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

htmlhelpers-0.1.1.tar.gz (5.6 kB view hashes)

Uploaded Source

Built Distribution

htmlhelpers-0.1.1-py3-none-any.whl (6.0 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