Giter Club home page Giter Club logo

hype-html's Introduction

hype

A minimal python dsl for generating html.

Install

Install via pip

pip install hype-html

Alternatively, in the spirit of removing dependencies, you could simply copy/paste the hype/element.py file into your project.

Usage

Hype exposes classes for each html tag.

from hype import *

doc = Doc(Html('Hello World!'))

print(doc)

# <!DOCTYPE html>
# <div>Hello World!</div>

Elements can also be rendered by calling their render method.

doc.render() == str(doc)

Inner HTML

Arguments passed in the element constructor are rendered using the str function and indented (if the element only has one argument it will not be indented.)

body = Body(
    H1('Hello World'),
    P('This is a paragraph'),
    'Just a string',
    P('Another paragraph')
)

print(body)

# <body>
#   <h1>Hello World</h1>
#   <p>This is a paragraph</p>Just a string
#   <p>Another paragraph</p>
# </body>

Append to an elements' list of inner html elements.

body = Body(
    H1('Hello World'),
    P('This is a paragraph'),
    'Just a string'
)

body.append(P('Another paragraph'))

print(body)

# <body>
#   <h1>Hello World</h1>
#   <p>This is a paragraph</p>Just a string
#   <p>Another paragraph</p>
# </body>

Attributes

Attributes are passed as keyword arguments to the element's constructor.

span = Span('span', width='50px')

print(span)

# <span width="50px">span</span>

Since some built-in, and possibly custom, attributes conflict with python keywords, keywords will automatically have all leading underscores stripped.

span = Span('span', _id='my-span', width='50px')

print(span)

# <span id="my-span" width="50px">span</span>

Any remaining underscores will be converted to hyphens.

span = Span('span', custom_attrbiute='custom')

print(span)

# <span custom-attribute="custom">span</span>

Also add attributes using a method's attrs method add keyword arguments.

span = Span('span')
span.attrs(_id='my-span', test='test')

print(span)

# <span id="my-span" test="test">span</span>

Custom Elements

If you to create a custom tag, just subtype the Element class and add a tag.

class CustomTag(Element):
    tag = 'custom-tag'

tag = CustomTag()
print(tag)

# <custom-tag></custom-tag>

To create a custom self closing tag, subtype the SelfClosingElement class.

class CustomTag(SelfClosingElement):
    tag = 'custom-tag'

tag = CustomTag()
print(tag)

# <custom-tag/>

Indents

The indent to be used can be passed as a keyword arg to the Doc constructor.

doc = Doc(content, indent=Indent.TAB)

It can also be passed as a keyword arg when calling and element.

div = Div(H1('Header'))
print(div(indent=Indent.FOUR_SPACES))

# <div>
#    <h1>Header</h1>
# </div>

Async Elements

If your elements content's use coroutines you can use the async elements in hype.asyncio.

The API is nearly identical with two main differences. Of course, the render method is a coroutine. Because of they do not render when calling the str function on them You must explicitly call their render method instead.

import ayncio

from hype.asyncio import *


div = Div(H1('Header'))

result = asyncio.run(div.render)
print(result)

# <div>
#    <h1>Header</h1>
# </div>

hype-html's People

Contributors

scrussell24 avatar

Stargazers

Volker L. avatar  avatar

Watchers

James Cloos avatar  avatar  avatar

hype-html's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.