puppygirl-py/README.md
2025-10-06 17:14:52 -04:00

54 lines
955 B
Markdown

# puppygirl
an easy to train html templating system
# usage
```html
<!-- index.html -->
<!DOCTYPE html>
<html lang="en">
<head>
<template id="pg-template">
<slot></slot>
</template>
</head>
<body>
<puppygirl-domme template="pg-template">
<p>rawerf :3</p>
</puppgirl-domme>
</body>
</html>
```
## cli
```
usage: puppygirl build [-h] [-p] [-r {client,server}] INPUT OUTPUT
positional arguments:
INPUT
OUTPUT
options:
-h, --help show this help message and exit
-p, --pretty
-r, --renderer {client,server}
```
```
$ puppygirl build --pretty --renderer server index.html dist/index.html
```
## programmatically
```py
pg = Puppygirl(
renderer=ServerSideRenderer(),
elements=[PuppygirlDomme]
)
# parsed using the above config
parsed = pg.fetch("index.html")
with open("dist/index.html", "w") as f:
f.write(parsed.prettify()) # parsed is a beautifulsoup4 object
```