https://github.com/mosquito/tagz
tagz is a html tags builder
https://github.com/mosquito/tagz
Last synced: 13 days ago
JSON representation
tagz is a html tags builder
- Host: GitHub
- URL: https://github.com/mosquito/tagz
- Owner: mosquito
- License: mit
- Created: 2023-09-17T12:10:56.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-07T14:07:11.000Z (over 1 year ago)
- Last Synced: 2025-03-23T19:22:28.820Z (29 days ago)
- Language: Python
- Size: 47.9 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-html - mosquito/tagz
- awesome-python-html - mosquito/tagz
README
[](https://github.com/mosquito/tagz/actions?query=branch%3Amaster)
[](https://coveralls.io/github/mosquito/tagz?branch=master)
[](https://pypi.python.org/pypi/tagz/)
[](https://pypi.python.org/pypi/tagz/)
[](https://pypi.python.org/pypi/tagz/)
[](https://pypi.python.org/pypi/tagz/)
# `tagz`
`tagz` – is an extremely simple library for building html documents without using templates,
just with python code.
```python
from tagz import Page, StyleSheet, Style, html
page = Page(
lang="en",
body_element=html.body(
html.h1("Hello"),
html.div(
html.strong("world"),
),
html.a(
"example link",
html.i("with italic text"),
href="https://example.com/"
),
),
head_elements=(
html.meta(charset="utf-8"),
html.meta(name="viewport", content="width=device-width, initial-scale=1"),
html.title("tagz example page"),
html.link(href="/static/css/bootstrap.min.css", rel="stylesheet"),
html.script(src="/static/js/bootstrap.bundle.min.js"),
html.style(
StyleSheet({
"body": Style(padding="0", margin="0"),
(".container", ".container-fluid"): Style(transition="opacity 600ms ease-in"),
})
)
),
)
# `pretty=False` should be faster but performs not a human-readable result
print(page.to_html5(pretty=True))
```
writes something like this:
```html
tagz example page
body {padding: 0; margin: 0;}
.container, .container-fluid {transition: opacity 600ms ease-in;}
Hello
world
example link
with italic text
```
# Features
* Any custom tags is supported:
```python
from tagz import html
assert str(html.my_custom_tag("hello")) == "hello"
```
* Pretty printing html
```python
from tagz import html
print(
html.div(
"Hello", html.strong("world"),
).to_string(pretty=True)
)
#
# Hello
#
# world
#
#
```
* `Style` helper object:
```python
from tagz import Style
assert str(Style(color="#ffffff")) == "color: #ffffff;"
```
* `StyleSheet` helper object
```python
from tagz import Style, StyleSheet
# body {padding: 0;margin: 0}
# a, div {transition: opacity 600ms ease-in}
print(
str(
StyleSheet({
"body": Style(padding="0", margin="0"),
("div", "a"): Style(transition="opacity 600ms ease-in"),
})
)
)
```
# More examples
## Building page from parts
You can reuse the code, and assemble the page piece by piece,
to do this you can modify elements already added to the tags:
```python
from tagz import html, Page
# Make an content element
content = html.div(id='content')
page = Page(
lang="en",
body_element=html.body(
html.h1("Example page"),
html.hr(),
# Adding it to the page
content,
),
head_elements=(
html.meta(charset="utf-8"),
html.title("tagz partial page"),
),
)
content.append("Example page content")
print(page.to_html5(pretty=True))
```
This prints something like this:
```html
tagz example page
Example page
Example page content
```
## Convert CSV to html table
```python
from io import StringIO
from urllib.request import urlopen
from csv import reader
from tagz import html, Page, Style
url = (
'https://media.githubusercontent.com/media/datablist/'
'sample-csv-files/main/files/organizations/'
'organizations-10000.csv'
)
csv = reader(StringIO(urlopen(url).read().decode()))
table = html.table(border='1', style=Style(border_collapse="collapse"))
content = list(csv)
# Make table header
table.append(html.tr(*map(html.th, content[0])))
# Add table rows
for csv_row in content[1:]:
table.append(html.tr(*map(html.td, csv_row)))
page = Page(
lang="en",
body_element=html.body(
html.h1("Converted CSV"),
table,
"Content of this page has been automatically converted from",
html.a(url, href=url),
),
head_elements=(
html.meta(charset="utf-8"),
html.title("tagz csv example page"),
),
)
with open("/tmp/csv.html", "w") as fp:
fp.write(page.to_html5())
```