Pypugjs

PugJS syntax adapter for Django, Jinja2 and Mako templates - forked from https://github.com/syrusakbary/pyjade

Generate Convert Improve

Install / Use

/learn @akubera/Pypugjs

About this skill

Quality Score

0/100

README

PyPugJS |PyPiPackage|_ |BuildStatus|_ |Coverage|_

.. |PyPiPackage| image:: https://badge.fury.io/py/pypugjs.svg .. _PyPiPackage: https://badge.fury.io/py/pypugjs

.. |BuildStatus| image:: https://travis-ci.org/kakulukia/pypugjs.svg .. _BuildStatus: https://travis-ci.org/kakulukia/pypugjs

.. |Coverage| image:: https://codecov.io/gh/kakulukia/pypugjs/branch/master/graph/badge.svg .. _Coverage: https://codecov.io/gh/kakulukia/pypugjs

PyPugJS is a fork of PyJade <http://github.com/syrusakbary/pyjade>_ with the name Jade changed to PugJS <https://github.com/pugjs/pug>_.

Additional disclaimer: Since the original pypugjs died i took the liberty to keep it alive, because since starting to work with the jade compiler for node I hate writing HTML and want to continue using it in my Django projects. I will keep the existing non Django stuff inside the project, but I cannot support anything other since I'm not actively using it not will be in the foreseable future. Tornado, Mako etc. support will be welcome tho!

PyPugJS is a high performance port of PugJS for python, that converts any .pug source into different Template-languages (Django, Jinja2, Mako or Tornado).

UTILITIES

To simply output the conversion to your console::

pypugjs [-c django|jinja|mako|tornado] input.pug [output.html]

INSTALLATION

To install pypugjs::

pip install pypugjs

Now simply name your templates with a .pug extension and this PugJS compiler will do the rest. Any templates with other extensions will not be compiled with the pypugjs compiler.

Framework specific installation instructions <docs/installation.rst>_

Syntax

Generally the same as the PugJS Node module (except of cases and several other features, which are not implemented) https://github.com/pugjs/pug/blob/master/README.md

Example

This code

.. code:: pug

!!! 5
html(lang="en")
  head
    title= pageTitle
    script(type='text/javascript').
      if (foo) {
         bar()
      }
  body
    h1.title PugJS - node template engine
    #container
      if youAreUsingPugJS
        p You are amazing
      else
        p Get on it!

Converts to

.. code:: html

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>{{pageTitle}}</title>
    <script type='text/javascript'>
      if (foo) {
         bar()
      }
    </script>
  </head>
  <body>
    <h1 class="title">PugJS - node template engine</h1>
    <div id="container">
      {%if youAreUsingPugJS%}
        <p>You are amazing</p>
      {%else%}
        <p>Get on it!</p>
      {%endif%}
    </div>
  </body>
</html>

Convert existing templates online with the HTML2Jade converter <http://www.html2jade.org/>_.

Register filters

If you want to register a function as a filter, you only have to decorate the function with pypugjs.register_filter("filter_name")

.. code:: python

import pypugjs

@pypugjs.register_filter('capitalize')
def capitalize(text, ast):
  return text.capitalize()

Notable Features

Adding conditional classes:

.. code:: pug

a(class={'active-class': True, 'another': False})

Define mixins like this mixins/foo.pug:

.. code:: pug

mixin foo(data)
  .foo {{ data }}

And use them in your templates like this:

.. code:: pug

include mixins/foo.pug

div
  +foo(data)

TESTING

To start the testsuite, start the following commands::

make init
make test

TODOs and BUGS

See: https://github.com/kakulukia/pypugjs/issues

ChangeLog <docs/HISTORY.rst>_

Related Skills

node-connect

353.3k

Diagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps

frontend-design

111.7k

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.

openai-whisper-api

353.3k

Transcribe audio via OpenAI Audio Transcriptions API (Whisper).

qqbot-media

353.3k

QQBot 富媒体收发能力。使用 <qqmedia> 标签，系统根据文件扩展名自动识别类型（图片/语音/视频/文件）。