stoic-html 2021.9.3

Stoic HTML: A simple wrapper around Django's `format_html()`

stoic-html

What is "stoic-html"?

Stoic HTML is a tiny wrapper around the method format_html() of the Django web framework.

Since I switched to developing the frontend with htmx.org I tend to write small function-based-views returning small HTML fragments.

That's why I switched from using a template language to creating the HTML directly inside my Python code.

That's in general considered dirty, and frowned upon.

For me it is Locality of Behaviour: I have all these things together in one place. That gives me a lot of power and speed.

Methods

Method join()

join(my_list, sep='', type=None, empty_text='')

Joins a list of strings to a SafeString with the help of conditional_escape()

type can be 'ul' or 'ol' to create HTML lists.

Method link()

link(obj, text=None)

Create a hyperlink to obj.

Returns something like 'text'

If "text" is empty, then str(obj) gets used.

Method admin_link()

admin_link(obj, text=None)

Returns a link to the admin-page of obj.

If "text" is empty, then str(obj) gets used.

Install

python3 -m venv stoic-html-env
cd stoic-html-env/
. bin/activate
pip install -U pip wheel
pip install -e git+ssh://[e-mail]/guettli/stoic-html.git#egg=stoic-html
cp src/stoic-html/.env.example src/stoic-html/.env
echo '. $VIRTUAL_ENV/src/stoic-html/.env' >> bin/activate
echo 'export $(cut -d= -f1 $VIRTUAL_ENV/src/stoic-html/.env)' >> bin/activate

. bin/activate

Naming convention

See: https://github.com/guettli/django-htmx-fun

Guidelines

See: https://github.com/guettli/programming-guidelines