A derivation of Nicolas Bessi's trivial port of Hiccup to Python
Project description
pyccup
Python version of clojure hiccup https://github.com/weavejester/hiccup Original concept by James Reeves
Pyccup is derived from nbessi's Pyhiccup library, and makes only incremental in python compatibility.
Pyccup is a library for representing HTML in Python. It uses list or tuple to represent elements, and dict to represent an element's attributes. Supports Python versions 3.4 and later.
Install
pip install pyccup
Syntax
Here is a basic example of pyccup syntax.
>>> from pyccup.core import html
>>> data = [
>>> ['div',
>>> {'class': 'a-class', 'data-y': '23'},
>>> ['span', 'my-text',
>>> ['ul', [['li', x] for x in ['café', 'milk', 'sugar']]]]]
>>> ]
>>> html(data)
u'<!DOCTYPE html><html lang="en" xml:lang="en" dir="rtl"><div data-y="23" class="a-class"><span>my-text<ul><li>café<li>milk<li>sugar</ul></span></div></html>'
The html function supports different default type html5, html4, xhtml-strict, xhtml-transitional
>>> from pyccup.core import html
>>> data = []
>>> html(data, etype='xhtml-strict')
>>> u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html lang="en" xml:lang="en" dir="rtl" xmlns="http://www.w3.org/1999/xhtml"/>'
You can pass arbitrary keyword arguments to the html they will be transformed into html tag attributes
>>> from pyccup.core import html
>>> data = []
>>> html(data, etype='xhtml-strict', an-attr='foo')
u'... <html an-attr="foo" lang="en" xml:lang="en" dir="rtl" xmlns="http://www.w3.org/1999/xhtml"/>'
Pyccup also provides a function to represent XML. Arbitrary keyword arguments are also supported.
>>> from pyccup.core import xml
>>> data = ['form-desc',
>>> ['field', {'name': 'a_name'}],
>>> ['field', {'name': 'a_other_name'}]]
>>> conv = xml(data, 'foo-ns', bar='an_attr')
u'<?xml version="1.0" encoding="UTF-8"?><foo-ns bar="an_attr"><form-desc><field name="a_name"/><field name="a_other_name"/></form-desc></foo-ns>'
Some time you want to be able to create XML/HTML chunk out of a namespace. The core.convert is made for this.
>>> from pyccup.core import convert
>>> from pyccup.element import link_to
>>> convert(link_to('http://github.com/inaimathi/pyccup', 'pyccup'))
u'<a href="http://github.com/inaimathi/pyccup">pyccup</a>'
Helpers are available on the elements namespace. The will help you to add hyperlink, images etc.
>>> from pyccup.element import link_to
>>> link_to(u'https://github.com/inaimathi/pyccup', u'pyccup' )
[u'a', {u'href': u'https://github.com/inaimathi/pyccup'}, u'pyccup']
Using pyccup.elems
The elems module provides constants for HTML/XML tag names, allowing for a more elegant and IDE-friendly syntax when constructing HTML/XML trees.
Basic Usage
import pyccup.elems as e
from pyccup.core import html
# Create an HTML tree
html_tree = [
e.html,
[e.head,
[e.title, "My Website"]],
[e.body,
[e.div, {"class": "container"},
[e.h1, "Welcome!"],
[e.p, "This is a paragraph with ", [e.strong, "bold text"], "."]]]
]
# Convert to HTML string
html_string = html(html_tree)
print(html_string)
Case Flexibility
The module supports both lowercase and uppercase tag names:
# These are equivalent
[e.div, [e.p, "Content"]]
[e.DIV, [e.P, "Content"]]
Available Tags
The module includes constants for all HTML5 tags, including:
- Document structure:
html,head,body - Headings:
h1throughh6 - Text containers:
p,div,span, etc. - Lists:
ul,ol,li - Forms:
form,input,button, etc. - Tables:
table,tr,td, etc. - And many more...
Special Cases
The del tag is available as del_ (with an underscore) to avoid conflict with Python's del keyword.
Integration with pyccup
This module is designed to work seamlessly with the rest of the pyccup library:
from pyccup.core import html, convert
import pyccup.elems as e
# For full HTML documents
document = html([
e.div, {"id": "content"},
[e.h1, "Title"],
[e.p, "Paragraph"]
])
# For HTML fragments
fragment = convert([
e.div, {"id": "content"},
[e.h1, "Title"],
[e.p, "Paragraph"]
])
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 Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyccup-0.0.3.tar.gz.
File metadata
- Download URL: pyccup-0.0.3.tar.gz
- Upload date:
- Size: 23.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e869a0a8270b7643c838261304a5d59fa30e27c3bf386d042240db7699dd2ed
|
|
| MD5 |
f8e0cfb13a1aa16fc4ef1702faa3fac7
|
|
| BLAKE2b-256 |
6af3250f063a5f4573581762ed67ac44fe067dd7ccc3a8325c7cbaf819ace3ee
|
File details
Details for the file pyccup-0.0.3-py3-none-any.whl.
File metadata
- Download URL: pyccup-0.0.3-py3-none-any.whl
- Upload date:
- Size: 21.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e46995accd3728ecdba937e99b2a3ee51fbc1d8987d3f3e215be169502a84768
|
|
| MD5 |
e4544513971917f696cd7084c6b0ee02
|
|
| BLAKE2b-256 |
9c284e0e5da291cf6843f71a8b73b3a30a82550291ddceae16a382604769f125
|
