Generate html with python 3. DOM API, Javascript API and more...

These details have not been verified by PyPI

Project links

Project description

domonic
^{_{^{Generate html with python 3! (and much more)}}}

Contains several evolving packages:

• html : Generate html with python 3 😎
• dom : DOM API in python 3 😲
• javascript : js API in python 3 😳
• dQuery - utils for querying domonic. (alt + 0 for the º symbol)
• terminal || cmd : call terminal commands with python3 😱 (see at the end)
• JSON : utils for loading / decorating / transforming
• SVG : Generate svg using python (untested)
• aframe || x3d tags : auto generate 3d worlds with aframe. (see examples folder)

See the docs/code for more features... https://domonic.readthedocs.io/

or examples in the repo...

(small footprint. with only a few common lightweight dependencies)

HTML Templating with Python 3

from domonic.html import *
print(html(body(h1('Hello, World!'))))

<html><body><h1>Hello, World!</h1></body></html>

or to format it and insert the doctype use an f-string:

mydom = html(body(h1('Hello, World!')))
print(f"{mydom}")

<!DOCTYPE html>
<html>
    <body>
        <h1>Hello, World!</h1>
    </body>
</html>

install

python3 -m pip install domonic

or if you had it before upgrade:

python3 -m pip install domonic --upgrade

attributes

prepend attributes with an underscore ( avoids clashing with python keywords )

test = label(_class='classname', _for="someinput")
print(test)

<label class="classname" for="someinput"></label>

rendering

cast str() on any element to render it without formatting.

el_string = str(div())
print(el_string)

there's also a render method that takes 2 parameters, some domonic and an optional output file.

page = div(span('Hello World'))
render(f"{page}", 'index.html')  # notice use of f-string to pretty print the html

Now try building your own static site generator!

decorators

use decorators to wrap elements around function results

from domonic.decorators import el

@el(html, True)
@el(body)
@el(div)
def test():
    return 'hi!'

print(test())
# <html><body><div>hi!</div></body></html>

# returns pyml objects so call str to render
assert str(test()) == '<html><body><div>hi!</div></body></html>'

It returns the tag object by default. You can pass True as a second param to the decorator to return a rendered string instead. Also accepts strings as first param i.e. custom tags.

data-tags

python doesn't allow hyphens in parameter names. so use variable keyword argument syntax for custom data-tags

div("test", **{"_data-test":"test"} )

or for example a colon...

t = div( **{"_:test":"something"} )
str(t)

DOM

DOM manipulation with python.

createElement

to create your own elements use the DOM API

from domonic.dom import *

site = html()
el = document.createElement('myelement')
site.appendChild(el)
print(site)

There's an evolving DOM API. To learn more about the webAPI go here.

https://developer.mozilla.org/en-US/docs/Web/API

And check the code/docs to see what's currently been implemented.

mysite.querySelectorAll('button') 

mysite.querySelectorAll("a[rel=nofollow]")
mysite.querySelectorAll("a[href='#services']")
mysite.querySelectorAll("a[href$='technology']")
mysite.querySelectorAll('.fa-twitter')

somelinks = mysite.querySelectorAll("a[href*='twitter']")
for l in somelinks:
    print(l.href)

To use the DOM either reference your root 'html' node or import the dom modules global 'document'

# access the document via the html tag
mydom = html()
# mydom.getElementbyID...

# or by importing the document global
from domonic.dom import document
# document.createElement...
print(document)

javascript

There is a javascript package that mimics the js API:

from domonic.javascript import Math
print(Math.random())

from domonic.javascript import Array
myArr=Array(1,2,3)
print(myArr.splice(1))

from domonic.javascript import URL
url = URL('https://somesite.com/blog/article-one#some-hash')
print(url.protocol)
print(url.host)
print(url.pathname)
print(url.hash)

# Use Global class to import all the js methods from the global namespace i.e
# from domonic.javascript import Global
# Global.decodeURIComponent(...
# Global.encodeComponent(...
# Global.setInterval(...

# from domonic.javascript import Date, String, Number
# etc..

Use setInterval and clearInterval with params

from domonic.javascript import setInterval, clearInterval

x=0

def hi(inc):
    global x
    x = x+inc
    print(x)

test = setInterval(hi, 1000, 2)
import time
time.sleep(5)
clearInterval(test)
print(f"Final value of x:{x}")

Or for a single delayed function call use setTimeout, clearTimeout

from domonic.javascript import setTimeout, clearTimeout

timeoutID = setTimeout(hi, 1000)

call () on a stringvar to transform it into a Node

    >>> from domonic.javascript import String

	>>> test = String("Hi there!")
	>>> test('div', _style="font-color:red;")
	>>> str(test('div', _style="font-color:red;"))

passing it the tag and attributes...

a-tags inherit URL:

from domonic.html import *

atag = a(_href="https://somesite.com:8000/blog/article-one#some-hash")
print('href:', atag.href)
print('protocol:', atag.protocol)
print('port:', atag.port)

atag.protocol = "http"
atag.port = 8983
print(atag)

For writing and using regular javascript, load from a src...

script(_src="/docs/5.0/dist/js/bootstrap.bundle.min.js", _integrity="sha384-1234", _crossorigin="anonymous"),

or do inline js by opening triple quotes...

script("""
let itbe = ""
"""),

Styling

Styling is supported. Styles get passed to the style tag on render...

mytag = div("hi", _id="test")
mytag.style.backgroundColor = "black"
mytag.style.fontSize = "12px"
print(mytag)
# <div id="test" style="background-color:black;font-size:12px;">hi</div>

To use css use a link tag as you usually would...

link(_href="styles.css", _rel="stylesheet"),

or use triple quotes to open style tag...

style("""
.placeholder-img {
    -webkit-user-select: none;
    -moz-user-select: none;
    -ms-user-select: none;
    user-select: none;
}
"""),

JSON (utils)

decorate any function that returns python objects to return json instead

from domonic.JSON import *

@return_json
def somefunc():
    myObj = {"hi":[1,2,3]}
    return myObj

print( somefunc() )
print( is_json(somefunc()) )

convert json arrays into html tables...

from domonic.JSON import *

# i.e. containting flat json array of dicts... [{"id":"01","name": "some item"},{"id":"02","name": "some other item"}]

json_data = JSON.parse_file('somefile.json')
mytable = JSON.tablify(json_data)
print(mytable)

convert json arrays into csv files...

from domonic.JSON import *

json_data = JSON.parse_file('somefile.json')
JSON.csvify(json_data, 'data.csv')

convert csv files to json...

from domonic.JSON import *

json_data =JSON.csv2json("data.csv")
print(json_data)

more to come...

SVG

All tags extend 'Node' and 'tag'. So will have DOM and magic methods available to them. see the docs.

        circ = svg(
            circle(_cx="50", _cy="50", _r="40", _stroke="green", **{"_stroke-width": "4"}, _fill="yellow"),
            _width="100", _height="100",
        )
        mysvg = svg()
        mysvg.appendChild(circ / 10)
        print(mysvg)

Tweening

Tween values with the tween library:

from domonic.lerpy.easing import *
from domonic.lerpy.tween import *

someObj = {'x':0,'y':0,'z':0}
twn = Tween( someObj, { 'x':10, 'y':5, 'z':3 }, 6, Linear.easeIn )
twn.start()

aframe / x3d

3d tags can be used if you import the js

from domonic.html import *
from domonic.xml.aframe import *
from domonic.CDN import *

_scene = scene(
      box(_position="-1 0.5 -3", _rotation="0 45 0", _color="#4CC3D9"),
      sphere(_position="0 1.25 -5", _radius="1.25", _color="#EF2D5E"),
      cylinder(_position="1 0.75 -3", _radius="0.5", _height="1.5", _color="#FFC65D"),
      plane(_position="0 0 -4", _rotation="-90 0 0", _width="4", _height="4", _color="#7BC8A4"),
      sky(_color="#ECECEC")
    )

_webpage = html(head(),body(
    script(_src=CDN_JS.AFRAME_1_2), # < NOTICE you need to import aframe to use it
    str(_scene)
    )
)

render( _webpage, 'hello.html' )

dQuery (NEW)

dQuery uses the º symbol (alt+0).

    d = html(head(body(li(_class='things'), div(_id="test"))))

    º(d) # you need to init a dom first. i.e. a html element

    # now you can use it
    print( º('#test') )
    print( º('.things') )
    a = º('<div class="test2"></div>')
    print( a )

    b = º('#test').append(a)
    print(b)

Only recently started so check to see what's implemented.

terminal

There is a command line package that can call bash/unix/posix and other apps on the command line:
This package only works on nix systems as it effectively just passes stuff off to subprocess.

from domonic.terminal import *

print(ls())
print(ls("-al"))
print(ls("../"))
print(pwd())
print(mkdir('somedir'))
print(touch('somefile'))
print(git('status'))

for file in ls( "-al" ):
    print("Line : ", file)

for f in ls():
    try:
        print(f)
        print(cat(f))
    except Exception as e:
        pass

for i, l in enumerate(cat('LICENSE.txt')):
    print(i,l)

print(man("ls"))
print(echo('test'))
print(df())
print(du())

for thing in du():
    print(thing)

print(find('.'))
# print(ping('eventual.technology'))# < TODO - need to strean output
print(cowsay('moo'))
print(wget('eventual.technology'))
print(date())
print(cal())

or just run arbitrary commands...

from domonic.terminal import command
command.run("echo hi")

Take a look at the code in 'terminal.py' to see all the commands as there's loads. (Disclaimer: not all tested.)

Windows users can use now use cmd.

from domonic.cmd import *
print(dir())
print(dir("..\\"))

parsing

domonic can work with other Treebuilders

There's a builtin ext to tap into html5lib. And also fork of the c++ htmlparser (see parsing ticket)

To use the pure python htm5lib with domonic you need to install it

pip install html5lib

Then use the domonic treebuilder instead of any of the html5lib treebuilders.

import requests
import html5lib
from domonic.ext.html5lib_ import getTreeBuilder


r = requests.get("https://google.com")
parser = html5lib.HTMLParser(tree=getTreeBuilder())
page = parser.parse(r.content.decode("utf-8"))

# print the page with formatting
# print(f'{page}')

'''
links = page.getElementsByTagName('a')
for l in links:
    try:
        print(l.href)
    except Exception as e:
        # no href on this tag
        pass
'''

# turn the downloaded site into .pyml ;)
print(page.__pyml__())

DOCS

https://domonic.readthedocs.io/

notes on templating

while you can create a div with content like :

div("some content")

python doesn't allow named params before unamed ones. So you can't do this:

div(_class="container", p("Some content") )

or it will complain the params are in the wrong order. You have to instead put content before attributes:

div( p("Some content"), _class="container")

which is annoying when a div gets long.

You can get around this by using 'html' which is available on every Element:

div( _class="container" ).html("Some content")

This is NOT like jQuery html func that returns just the inner content. use innerHTML for that.

It is used specifically for rendering.

Common Errors

If templates are typed incorrectly they will not work.

There's a small learning curve getting .pyml templates correct. Usually (1) a missing comma between tags, (2) an underscore missing on an attribute or (3) params in the wrong order. Use this reference when starting out as a reminder when you get an error.

Here are the 4 solutions to those common errors when creating large templates... ( i.e. see bootstrap5 examples in test_domonic.py )

IndexError: list index out of range - You most likely didn't put a underscore on an attribute.

SyntaxError: invalid syntax - You are Missing a comma between attributes

SyntaxError: positional argument follows keyword argument - You have to pass attributes LAST. and strings and objects first. see notes on templating above

TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'dict' - You are Missing a comma between attributes. before the **{}

CLI

Use the command line interface to help you out.

To launch the docs for a quick reference to the APIs use:

python3 -m domonic -h

EXAMPLE PROJECTS

A browser based file browser. Working example of how components can work: Blueberry

A cron viewer: ezcron

A basic game: https://github.com/byteface/bombdisposer/

checkout the docs for examples on how to easily make sitemaps with python. or for example how to use domonic with flask, django, sanic and other server frameworks.

docs: https://domonic.readthedocs.io/

There's also several useage examples in the repo so pull and have a look.

Join-In

Feel free to contribute if you find it useful. (I'd be grateful for help on all fronts)

Email me, message me directly if you like or create a discussion on here. Or join the discord.

If there are any methods you want that are missing or not complete yet or you think you can help make it better just update the code and send a pull request.

I'll merge and releaese asap.

In the repo there's a requirements-dev.txt which is mostly the libs used in the examples.

requirements.txt are the libs used for packaging just the lib.

running examples

. venv/bin/activate
pip install -r requirements-dev.txt
cd examples
python lifecalendar.py

run tests

There are tests used during dev. They are useful as code examples and to see what still needs doing.

See Makefile to run all tests:

make test  # default tests ubuntu. so will fail on window when terminal test runs. comment out locally if that's the case

or to test a single function:

python -m unittest tests.test_javascript.TestCase.test_javascript_array
python -m unittest tests.test_dQuery.TestCase.test_addClass
python -m unittest tests.test_geom.TestCase.test_vec2

python3 -m unittest tests.test_cmd.TestCase.test_cmd_dir  # only windows

or to test a whole module

python -m unittest tests.test_html
python -m unittest tests.test_CDN

to see coverage

coverage run -m unittest discover tests/
coverage report

rebuild docs

See Makefile:

. venv/bin/activate
cd docs
make html

Disclaimer

There's several more widely supported libraries doing HTML generation, DOM reading/manipulation, terminal wrappers etc. Maybe use one of those for production due to strictness and support.

This is more of a fast prototyping library.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

0.9.12

Nov 6, 2023

0.9.11

Jun 28, 2022

0.9.10

Apr 10, 2022

0.9.9

Apr 5, 2022

0.9.8

Mar 24, 2022

0.9.7

Feb 26, 2022

0.9.6

Feb 25, 2022

0.9.5

Feb 23, 2022

0.9.4

Feb 17, 2022

0.9.3

Feb 15, 2022

0.9.1

Feb 11, 2022

0.9.0

Jan 24, 2022

0.8.5

Jan 22, 2022

0.8.4

Jan 16, 2022

0.8.3

Dec 14, 2021

0.8.2

Dec 4, 2021

0.8.1

Dec 4, 2021

0.8.0

Dec 3, 2021

0.7.3

Nov 30, 2021

0.7.2

Nov 23, 2021

0.7.1

Nov 20, 2021

0.7.0

Nov 17, 2021

0.6.9

Nov 6, 2021

This version

0.6.8

Nov 5, 2021

0.6.7

Oct 31, 2021

0.6.6

Oct 28, 2021

0.6.5

Oct 27, 2021

0.6.4

Oct 25, 2021

0.6.3

Oct 20, 2021

0.6.2

Oct 12, 2021

0.6.1

Oct 9, 2021

0.6.0

Sep 26, 2021

0.5.1

Sep 11, 2021

0.5.0

Sep 6, 2021

0.4.8

Aug 26, 2021

0.4.7

Aug 21, 2021

0.4.6

Aug 15, 2021

0.4.5

Aug 13, 2021

0.4.4

Aug 8, 2021

0.4.3

Aug 8, 2021

0.4.2

Aug 5, 2021

0.4.1

Aug 5, 2021

0.4.0

Jul 29, 2021

0.3.19

Jul 21, 2021

0.3.18

Jul 10, 2021

0.3.17

Jul 6, 2021

0.3.16

Jul 4, 2021

0.3.15

Jul 4, 2021

0.3.14

Jul 3, 2021

0.3.13

Jul 1, 2021

0.3.12

Jun 27, 2021

0.3.11

Jun 26, 2021

0.3.10

Jun 24, 2021

0.3.9

Jun 10, 2021

0.3.8

Jun 2, 2021

0.3.7

Jun 1, 2021

0.3.6

May 30, 2021

0.3.5

May 30, 2021

0.3.4

May 29, 2021

0.3.3

May 28, 2021

0.3.2

May 4, 2021

0.3.1

May 3, 2021

0.3.0

May 3, 2021

0.2.18

May 2, 2021

0.2.17

May 1, 2021

0.2.16

Apr 27, 2021

0.2.15

Apr 26, 2021

0.2.14

Apr 26, 2021

0.2.13

Apr 17, 2021

0.2.12

Apr 16, 2021

0.2.11

Sep 27, 2020

0.2.10

Sep 20, 2020

0.2.9

Sep 14, 2020

0.2.8

Sep 13, 2020

0.2.7

Sep 6, 2020

0.2.6

Sep 5, 2020

0.2.5

Sep 4, 2020

0.2.4

Sep 4, 2020

0.2.3

Sep 4, 2020

0.2.2

Sep 3, 2020

0.2.1

Sep 2, 2020

0.2.0

Sep 2, 2020

0.1.12

Sep 2, 2020

0.1.11

Aug 31, 2020

0.1.10

Aug 31, 2020

0.1.9

Aug 30, 2020

0.1.8

Aug 30, 2020

0.1.7

Aug 29, 2020

0.1.6

Aug 24, 2020

0.1.5

Aug 20, 2020

0.1.4

Aug 20, 2020

0.1.3

Aug 19, 2020

0.1.2

Aug 13, 2020

0.1.1

Jul 6, 2020

0.1.0

Jul 6, 2020

0.0.9

Jul 2, 2020

0.0.8

Jul 1, 2020

0.0.7

Jul 1, 2020

0.0.6

Jun 29, 2020

0.0.5

Jun 27, 2020

0.0.4

Jun 17, 2020

0.0.3

Jun 17, 2020

0.0.2

Jun 15, 2020

0.0.1

Jun 15, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

domonic-0.6.8.tar.gz (300.7 kB view details)

Uploaded Nov 5, 2021 Source

Built Distribution

domonic-0.6.8-py3-none-any.whl (264.1 kB view details)

Uploaded Nov 5, 2021 Python 3

File details

Details for the file domonic-0.6.8.tar.gz.

File metadata

Download URL: domonic-0.6.8.tar.gz
Upload date: Nov 5, 2021
Size: 300.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.26.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for domonic-0.6.8.tar.gz
Algorithm	Hash digest
SHA256	`8e034a80e345968d35b58061be7064503399ba9be1de93370024ef39b6b5f9cc`
MD5	`8e77da404ec73a5f34218f7972652046`
BLAKE2b-256	`c02eda5069663fd1afd369e4ae3fb41841273fbf0acb2ea39a42c6f62a54e9cf`

See more details on using hashes here.

File details

Details for the file domonic-0.6.8-py3-none-any.whl.

File metadata

Download URL: domonic-0.6.8-py3-none-any.whl
Upload date: Nov 5, 2021
Size: 264.1 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.26.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for domonic-0.6.8-py3-none-any.whl
Algorithm	Hash digest
SHA256	`e66549e94a61b30e7b82cb3269392e415a7d897040bbec76d006d0de968bbd0e`
MD5	`858b9d4d5075e6224cf12043cb962f12`
BLAKE2b-256	`d335975604e6846352b30b8c918f9ed4609850a0ece5d12f01e6c91cf6c3355e`

See more details on using hashes here.

domonic 0.6.8

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

domonic Generate html with python 3! (and much more)

Contains several evolving packages:

HTML Templating with Python 3

install

attributes

rendering

decorators

data-tags

DOM

createElement

javascript

Styling

JSON (utils)

SVG

Tweening

aframe / x3d

dQuery (NEW)

terminal

parsing

DOCS

notes on templating

Common Errors

CLI

EXAMPLE PROJECTS

Join-In

running examples

run tests

rebuild docs

Disclaimer

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

domonic
^{_{^{Generate html with python 3! (and much more)}}}