PKG-INFO

Metadata-Version: 1.1
Name: pypugjs
Version: 4.2.2
Summary: PugJS syntax template adapter for Django, Jinja2, Mako and Tornado templates - copy of PyJade with the name changed
Home-page: http://github.com/matannoam/pypugjs
Author: Matan Noam Shavit
Author-email: matannoam@gmail.com
License: MIT
Download-URL: https://github.com/matannoam/mypackage/pypugjs/4.2.2.tar.gz
Description: =======
        PyPugJS
        =======
        
        **PyPugJS is just a fork of** `PyJade <http://github.com/syrusakbary/pyjade>`_
        **with the name Jade changed to** `PugsJS <https://github.com/pugjs/pug>`_.
        
        PyPugJS is a high performance port of PugJS for python, that converts any .pug source to the each Template-language (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
        ============
        
        First, you must do::
        
            pip install pypugjs
        
        Or::
        
            python setup.py install
        
        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.
        
        
        Django
        ------
        
        In `settings.py`, add a `loader` to `TEMPLATES` like so:
        
        .. code:: python
        
            TEMPLATES = [
                {
                    'BACKEND': 'django.template.backends.django.DjangoTemplates',
                    'DIRS': [],
                    'OPTIONS': {
                        'context_processors': [
                            'django.template.context_processors.debug',
                            'django.template.context_processors.request',
                            'django.contrib.auth.context_processors.auth',
                            'django.contrib.messages.context_processors.messages',
                            'django.core.context_processors.request'
                        ],
                        'loaders': [
                            # PyPugJS part:   ##############################
                            ('pypugjs.ext.django.Loader', (
                                'django.template.loaders.filesystem.Loader',
                                'django.template.loaders.app_directories.Loader',
                            ))
                        ],
                        'builtins': ['pypugjs.ext.django.templatetags'],  # Remove this line for Django 1.8
                    },
                },
            ]
        
        
        Jinja2
        ------
        
        Just add `pypugjs.ext.jinja.PyPugJSExtension` as extension
        
        .. code:: python
        
            jinja_env = Environment(extensions=['pypugjs.ext.jinja.PyPugJSExtension'])
        
        
        Mako
        ----
        
        Just add  `pypugjs.ext.mako.preprocessor` as preprocessor
        
        .. code:: python
        
            from pypugjs.ext.mako import preprocessor as mako_preprocessor
            mako.template.Template(haml_source,
                preprocessor=mako_preprocessor
            )
        
        
        Flask
        -----
        
        Just add  `pypugjs.ext.jinja.PyPugJSExtension` as extension to the environment of the app
        
        .. code:: python
        
            app.jinja_env.add_extension('pypugjs.ext.jinja.PyPugJSExtension')
        
        
        Pyramid
        -------
        
        Adjust your "your_project/__init__.py" and add the following line somewhere to in the main() function
        
        .. code:: python
        
            config.include('pypugjs.ext.pyramid')
        
        
        Tornado Templates
        -----------------
        
        Append this after importing tornado.template
        
        .. code:: python
        
            from tornado import template
            from pypugjs.ext.tornado import patch_tornado
            patch_tornado()
        
            (...)
        
        
        Syntax
        ======
        
        Generally the same as the PugJS Node.js 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:: jade
        
            !!! 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>
        
        
        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()
        
        
        TESTING
        =======
        
        You must have `nose` package installed.
        You can do the tests with::
            
            ./test.sh
        
        
        TODOs and BUGS
        ==============
        See: http://github.com/matannoam/pypugjs/issues
        
Keywords: pug pugjs template converter
Platform: UNKNOWN