https://github.com/kakulukia/pypugjs

PugJS syntax adapter for Django, Jinja2 and Mako templates
https://github.com/kakulukia/pypugjs

django jade pug template-engine

Last synced: 13 days ago
JSON representation

PugJS syntax adapter for Django, Jinja2 and Mako templates

• Host: GitHub
• URL: https://github.com/kakulukia/pypugjs
• Owner: kakulukia
• License: mit
• Fork: true (akubera/pypugjs)
• Created: 2017-02-24T06:46:10.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T10:41:27.000Z (8 months ago)
• Last Synced: 2025-01-13T14:14:01.425Z (20 days ago)
• Topics: django, jade, pug, template-engine
• Language: Python
• Homepage:
• Size: 521 KB
• Stars: 258
• Watchers: 7
• Forks: 40
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
PyPugJS |PyPiPackage| |BuildStatus| |Coverage|

===================================================

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

   :target: https://badge.fury.io/py/pypugjs

.. |BuildStatus| image:: https://github.com/kakulukia/pypugjs/actions/workflows/tests.yml/badge.svg

   :target: https://github.com/kakulukia/pypugjs/actions/workflows/tests.yml

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

   :target: https://codecov.io/gh/kakulukia/pypugjs

**PyPugJS is a fork of** `PyJade `_

**with the name Jade changed to** `PugJS `_.

**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 nor will be in the foreseeable 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 `_

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

    

    

      

        {{pageTitle}}

        

          if (foo) {

             bar()

          }

        

      

      

        
PugJS - node template engine

        


          {%if youAreUsingPugJS%}

            
You are amazing

          {%else%}

            
Get on it!

          {%endif%}

        

      

    


Convert existing templates online with the `HTML2Jade converter `_.

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)

*Mixins might not work, depending on the used Framework.

The following have been reported as broken:*

* Django (v4.2)

TESTING

=======

To start the testsuite, start the following commands::

    make init

    make test

TODOs and BUGS

==============

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

`ChangeLog `_