Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Parnassius/domify
HTML generator using pure Python
https://github.com/Parnassius/domify
Last synced: 7 days ago
JSON representation
HTML generator using pure Python
- Host: GitHub
- URL: https://github.com/Parnassius/domify
- Owner: Parnassius
- License: mit
- Created: 2021-11-03T11:39:00.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T18:25:36.000Z (about 1 month ago)
- Last Synced: 2024-09-10T20:12:29.912Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 268 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-html - Parnassius/domify
- awesome-python-html - Parnassius/domify
README
# domify
HTML generator using pure Python.
[](https://pypi.org/project/domify/)
[](https://pypi.org/project/domify/)
[](https://pypi.org/project/domify/)
[](https://github.com/psf/black)
[](https://github.com/Parnassius/domify/actions/workflows/main.yml)
[](https://github.com/Parnassius/domify/blob/main/LICENSE)
Simple example:
```python
from domify import html_elements as e
html = e.Html(lang="en")
with html:
with e.Head():
e.Meta(charset="utf-8")
e.Title("Example page")
with e.Body():
e.H1("Hello world")
e.P("Lorem ipsum ", e.I("dolor sit amet"))
print(str(html))
```
HTML output (formatted for legibility):
```html
Example page
Hello world
Lorem ipsum dolor sit amet
```
Note: every example on this page assumes domify has already been imported:
```python
from domify import html_elements as e
```
`domify.html_elements` contains a class for each HTML element, with the first letter
converted to uppercase:
```python
p = e.P("Lorem ipsum dolor sit amet")
print(str(p))
```
```html
Lorem ipsum dolor sit amet
```
You can pass strings or additional elements as positional arguments, and they will be
treated as children:
```python
p = e.P("Lorem ipsum dolor sit amet", e.Br(), "consectetur adipiscing elit.")
print(str(p))
```
```html
Lorem ipsum dolor sit amet
consectetur adipiscing elit.
```
Attributes can be passed as keyword arguments, optionally appending an underscore to
attributes which are reserved keywords in python (for example `class`). Integers and
floats are automatically converted to strings, while additional underscores are replaced
with dashes (especially useful for `data` and `aria` attributes):
```python
btn = e.Button("Click!", type="submit", class_="someclass", data_order=155)
print(str(btn))
```
```html
Click!
```
HTML5 boolean attributes accept a boolean value instead:
```python
text_input = e.Input(type="text", required=True, disabled=False)
print(str(text_input))
```
```html
```
Attributes can be added or modified by subscripting an element object:
```python
html = e.Html()
html["lang"] = "en"
print(str(html))
```
```html
```
Children can be modified (but not added) by subscripting as well:
```python
p = e.P("Text node 1", e.Br(), "Text node 2")
p[0] = "Text node 3"
p[1:] = [e.Hr()]
print(str(p))
```
```html
Text node 3
```
The `del` keyword can be used to delete both attributes and children:
```python
div = e.Div("foo", e.Br(), "bar", e.Br(), "bar", id="someid", class_="someclass")
del div["class"]
del div[3:]
print(str(div))
```
```html
foo
bar
```
`add_class` and `remove_class` can be used to manage classes:
```python
div = e.Div(class_="some-class some-other-class")
div.remove_class("some-class")
div.add_class("third-class")
print(str(div))
```
```html
```
Children can be added using the `add` or `insert` methods, which return the newly added
element:
```python
div = e.Div()
span = div.add(e.Span())
span.add("First line")
span.add(e.Br())
span.add("Second line")
div.insert(0, e.H1("Title"))
print(str(div))
```
```html
Title
First line
Second line
```
Context managers can be used to add child elements too:
```python
with e.Select() as select:
e.Option("Option 1", value=1)
e.Option("Option 2", value=2)
e.Option("Option 3", value=3)
print(str(select))
```
```html
Option 1
Option 2
Option 3
```
The `+` operator can be used to concatenate multiple elements and/or strings:
```python
username = "Username: " + e.Input(type="text", name="username")
password = "Password: " + e.Input(type="password", name="password")
login_form = e.Label(username) + e.Label(password)
login_form += e.Button("Login", type="submit")
print(str(login_form))
```
```html
Username:
Password:
Login
```
Text nodes can be created using `TextNode` (this is usually not required, since strings
are automatically coverted):
```python
with e.P() as p:
e.TextNode("Lorem ipsum")
print(str(p))
```
```html
Lorem ipsum
```
`RawTextNode` can be used to add strings without escaping:
```python
with e.P() as p:
e.TextNode("TextNode")
e.Br()
e.RawTextNode("RawTextNode")
print(str(p))
```
```html
<i>TextNode</i>
RawTextNode
```