Simple and efficient Template Engine for Python projects

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

marcosstefani

These details have not been verified by PyPI

Project description

This is a very important project.

Sucuri

Simple and efficient template engine for Python projects inspired by PugJS

Instaling

Install and update using pip:

pip install sucuri

Creating a Sucuri Template

Example of code:

html
    body
        h1 Title
        a(href='#') This is my link

As can be seen in the code example above, the sucuri development requires tabulation standardization. We do not determine the number of spaces, but it is necessary to keep the same number of spaces on the left in the whole code, because this quantity will inform if a certain TAG of the HTML will be contained within another one or not. With this, in the example above we will have the following HTML code:

<html>
    <body>
        <h1>Title</h1>
        <a href="#">This is my link</a>
    </body>
</html>

Using

To use sucuri, you need to import the sucuri package into your Python file, the example below is an application that uses the sucuri to render in the Flask:

from sucuri import rendering
from flask import Flask, render_template_string

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template.suc')
    return render_template_string(template)

Command Line Interface (CLI)

Sucuri provides a Command Line Interface (CLI) that allows you to easily process templates directly from your terminal. When you install sucuri, the sucuri command is automatically registered system-wide.

To compile a .suc file locally and optionally pass dynamic JSON data for rendering variables:

# Basic compilation (outputs to stdout)
sucuri build index.suc

# Compilation with output file
sucuri build index.suc -o index.html

# Compilation passing JSON context variables inline
sucuri build index.suc --context '{"title": "My Page", "items": ["Item 1", "Item 2"]}' -o index.html

# Compilation using JSON data loaded from another file
sucuri build index.suc --context context.json -o index.html

As can be seen in the example above, the template in the example is loaded from a file named template.suc which is in the project's root directory, however it could be in any project directory, such as templates/template.suc if you include a folder to group the templates. At the first access to the archive, it will take care of storing it in memory, thus making access to information less costly and more efficient.

Text

In sucuri, texts are described in two ways. It can be written after the declaration of the tag such as:

h1 Title

Result:

<h1>Title</h1>

Or you can type in more than one line using the | on the lines that are not the same as the tag, see example:

h3 Hello!
    | Text
    | with
    | more than
    | one line

Result:

<h3>Hello!
    Text
    with
    more than
    one line
</h3>

Attributes

Just as in HTML the attributes in the sucuri must be separated by space and unlike the PugJS must be in a row only and can not be separated by commas. They must necessarily be enclosed in parentheses. See examples of the use of attributes below:

a(href='google.com') Google
a(class='button' href='google.com') Google
div(class='div-class')

Result:

<a href="google.com">Google</a>
<a class="button" href="google.com">Google</a>
<div class="div-class"></div>

Rendering of data

We already know (seen in the text above) that we can only use the template('template_name') function with a simple .suc file, however it is possible to pass information through a JSON to the template and the sucuri will automatically render the data in the proper location, see the example below:

Sucuri file:

html
    body
        h1 Hello {a}
            | Title
            | More
        a(href='#') This is my link
        h3 {b}

Python example with data:

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template_data.suc',{"a": 1, "b": "Hello!"})
    return render_template_string(template)

Result:

<html>
    <body>
        <h1>Hello 1
        Title
        More
        </h1>
        <a href="#">This is my link</a>
        <h3>Hello!</h3>
    </body>
</html>

Injecting template

Code reuse can be done through injected templates. This facility makes reuse of the code very efficient and enables the creation of code components. In the sucuri the identification of an injection occurs through an include at the beginning of the .suc file and its use is carried out using the + symbol before the name of the file that was imported. See the example below using this feature:

Sucuri file (template_include.suc):

include inc/link
include inc/list

html
    body
        h1 Hello
            | Title
            | More
        +link
        h3 Oh Yeahh
        +list

File inside the folder inc called link.suc (inc/link.suc):

a(href='#') {text}

File inside the folder inc called list.suc (inc/list.suc):

ul
    li A
    li B

Python example:

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template_include.suc',{"text": "Hello! I'm here!"})
    return render_template_string(template)

Result:

<html>
    <body>
        <h1>Hello
        Title
        More
        </h1>
        <a href="#">Hello! I'm here!</a>
        <h3>Oh Yeahh</h3>
        <ul>
            <li>A</li>
            <li>B</li>
        </ul>
    </body>
</html>

Condition (if)

It is possible to use conditional statements within Sucuri. Conditions are using the same form as Python's. Hence, the main operators are == and !=. See an example below:

Main file

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template_if.suc',{"x": 1, "y": 3})
    return render_template_string(template)

Sucuri file (template_if.suc):

include inc/if

html
    body
        h1 Hello
            | Title
            | More
        +if

File inside the folder inc called if.suc (inc/if.suc):

<if x != y>
h2 The condition is True
<endif>

Result:

<html>
    <body>
        <h1>Hello
            Title
            More
        </h1>
        <h2> The condtition is True </h2>
    </body>
</html>

Loop (for)

Sucuri has a loop in collections of objects, so it is necessary to use the object that has this characteristic as a parameter and to use the information in that collection. See the example below:

Main file

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template.suc',{"text": "Hello! I'm here!", "var":[1, 2, 3, 4]})
    return render_template_string(template)

Sucuri file (template_include.suc):

include inc/link
include inc/list

html
    body
        h1 Hello
            | Title
            | More
        +link
        h1 Test
        +list

File inside the folder inc called link.suc (inc/link.suc):

a(href='#') {text}

File inside the folder inc called list.suc (inc/list.suc):

ul
    <for a in var>
    li Value #a
    h1 test
    ul
        <for w in var>
        li Another #w
        <endfor>
    <endfor>

Result:

<html>
    <body>
        <h1>Hello
            Title
            More
        </h1>
        <a href="#">Hello! I'm here!</a>
        <h1>Test</h1>
        <ul>
            <li>Value 1</li>
            <h1>test</h1>
            <ul>
                <li>Another 1</li>
                <li>Another 2</li>
                <li>Another 3</li>
                <li>Another 4</li>
            </ul>
            <li>Value 2</li>
            <h1>test</h1>
            <ul>
                <li>Another 1</li>
                <li>Another 2</li>
                <li>Another 3</li>
                <li>Another 4</li>
            </ul>
            <li>Value 3</li>
            <h1>test</h1>
            <ul>
                <li>Another 1</li>
                <li>Another 2</li>
                <li>Another 3</li>
                <li>Another 4</li>
            </ul>
            <li>Value 4</li>
            <h1>test</h1>
            <ul>
                <li>Another 1</li>
                <li>Another 2</li>
                <li>Another 3</li>
                <li>Another 4</li>
            </ul>
        </ul>
    </body>
</html>

Lists

It is possible to generate unordered bullet list (<ul>) and checkboxex with Sucuri. This requires that the Python list given as argument is only a one dimension list for unordered lists and two (the list of the items and the list of the checked items) for the checkboxes. See an example below:

Main file

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template_list.suc',{"items": [1, "two", 3, "Five"], "checked": [1, "Five"]})
    return render_template_string(template)

Sucuri file (template_list.suc):


html
    body
        h1 Hello
        list(items)
        list(items checked)

Result:

<html>
    <body>
        <h1>Hello</h1>
        <ul>
            <li> 1 </li>
            <li> two </li>
            <li> 3 </li>
            <li> Five </li>
        </ul>
        <input type="checkbox" id="ck-1" checked="checked">1
        <input type="checkbox" id="ck-two">two
        <input type="checkbox" id="ck-3">3
        <input type="checkbox" id="ck-Five" checked="checked">Five
    </body>
</html>

list() also takes the optional argument class, which can be used to set the class of unordered lists like so:

Main file

from flask import Flask, render_template_string
from sucuri import rendering

app = Flask(__name__)

@app.route("/")
def index():
    template = rendering.template('template_list_with_classes.suc',{"items": [1, "two", 3, "Five"]})
    return render_template_string(template)

Sucuri file (template_list_with_classes.suc):

style static/css/list

html
    body
        h1 Hello
        list(items class="ul-squares")

Result:

<html>
    <body>
        <h1>Hello</h1>
        <ul class="ul-squares">
            <li> 1 </li>
            <li> two </li>
            <li> 3 </li>
            <li> Five </li>
        </ul>
    </body>
</html>

Injecting Style (css) or Script (js)

To inject style or script into your html, the sucuri uses the style command that should come before the commands that will translate the html, in this case along with the import of the file however with the style tag for css and the script tag for js files.

Sucuri file (template.suc):

include inc/link
include inc/list
style static/css/style
script static/js/script

html
    body
        h1 Hello
            | Title
            | More
        +link
        h1 Test
        +list

Include List:

style static/css/list
ul
    <for a in var>
    li Value #a
    h1(class='h1-red') test
    ul
        <for w in var>
        li Another #w
        <endfor>
    <endfor>

style static/css/style.css

h1 {
    color: blue;
}

style static/css/list.css

.h1-red {
    color: red;
}

script static/js/script.js

function example() {
    console.log('test');
}

Result:

<html>
   <head></head>
   <body>
      <h1>Hello
         Title
         More
      </h1>
      <a href="#">Hello! I'm here!</a>
      <h1>Test</h1>
      <ul>
         <li>Value 1</li>
         <h1 class="h1-red">test</h1>
         <ul>
            <li>Another 1</li>
            <li>Another 2</li>
            <li>Another 3</li>
            <li>Another 4</li>
         </ul>
         <li>Value 2</li>
         <h1 class="h1-red">test</h1>
         <ul>
            <li>Another 1</li>
            <li>Another 2</li>
            <li>Another 3</li>
            <li>Another 4</li>
         </ul>
         <li>Value 3</li>
         <h1 class="h1-red">test</h1>
         <ul>
            <li>Another 1</li>
            <li>Another 2</li>
            <li>Another 3</li>
            <li>Another 4</li>
         </ul>
         <li>Value 4</li>
         <h1 class="h1-red">test</h1>
         <ul>
            <li>Another 1</li>
            <li>Another 2</li>
            <li>Another 3</li>
            <li>Another 4</li>
         </ul>
      </ul>
      <style>h1 {
         color: blue;
         }.h1-red {
         color: red;
         }
      </style>
      <script>function example() {
         console.log('test');
         }
      </script>
   </body>
</html>

Project details

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

marcosstefani

These details have not been verified by PyPI

Release history Release notifications | RSS feed

1.0.26

Jun 1, 2026

1.0.25

May 31, 2026

1.0.24

May 28, 2026

1.0.23

May 26, 2026

1.0.22

May 26, 2026

1.0.21

May 25, 2026

1.0.20

May 25, 2026

1.0.19

May 25, 2026

1.0.18

May 25, 2026

1.0.17

May 25, 2026

1.0.16

May 25, 2026

1.0.15

May 24, 2026

1.0.14

May 24, 2026

1.0.13

May 24, 2026

1.0.12

May 24, 2026

1.0.11

May 24, 2026

1.0.10

May 21, 2026

1.0.9

May 19, 2026

1.0.8

May 19, 2026

1.0.7

May 19, 2026

1.0.6

May 18, 2026

1.0.5

May 18, 2026

This version

1.0.4

May 18, 2026

1.0.3

May 18, 2026

1.0.2

May 18, 2026

1.0.1

May 16, 2026

0.2.6

Feb 4, 2019

0.2.5

Nov 3, 2018

0.2.4

Jul 22, 2018

0.2.2

Apr 25, 2018

0.2.1

Apr 3, 2018

0.2.0

Mar 24, 2018

0.1.9

Mar 23, 2018

0.1.8

Mar 22, 2018

0.1.7

Mar 21, 2018

Download files

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

Source Distribution

sucuri-1.0.4.tar.gz (17.2 kB view details)

Uploaded May 18, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sucuri-1.0.4-py2.py3-none-any.whl (11.9 kB view details)

Uploaded May 18, 2026 Python 2Python 3

File details

Details for the file sucuri-1.0.4.tar.gz.

File metadata

Download URL: sucuri-1.0.4.tar.gz
Upload date: May 18, 2026
Size: 17.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sucuri-1.0.4.tar.gz
Algorithm	Hash digest
SHA256	`aea0b21eed1e588c38fddf2060df18a67a2e65b4781a375d50ea0d1fe7e6441c`
MD5	`cf3a311bd4ce4eb7df440d1e41240e8f`
BLAKE2b-256	`76971e17b24bb7746f8092e458bab3574a645a0d6bfd86b8f544d713e52b43e2`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sucuri-1.0.4.tar.gz:

Publisher: publish-pypi.yml on marcosstefani/sucuri

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sucuri-1.0.4.tar.gz
- Subject digest: aea0b21eed1e588c38fddf2060df18a67a2e65b4781a375d50ea0d1fe7e6441c
- Sigstore transparency entry: 1566842710
- Sigstore integration time: May 18, 2026
Source repository:
- Permalink: marcosstefani/sucuri@14c658309707383e2422417839617d28e23dbaf1
- Branch / Tag: refs/tags/v1.0.4
- Owner: https://github.com/marcosstefani
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-pypi.yml@14c658309707383e2422417839617d28e23dbaf1
- Trigger Event: push

File details

Details for the file sucuri-1.0.4-py2.py3-none-any.whl.

File metadata

Download URL: sucuri-1.0.4-py2.py3-none-any.whl
Upload date: May 18, 2026
Size: 11.9 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sucuri-1.0.4-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`e79a5daa42278e078120047952a4af5bb6faf56c35452ae6f0c1d29fe51ce8dc`
MD5	`0130b361d1a0e2e36d087faf0aaf66ca`
BLAKE2b-256	`427467a923c26d88f11de6533823218cb4412d6b17c9bc4c558cfdb66188af42`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sucuri-1.0.4-py2.py3-none-any.whl:

Publisher: publish-pypi.yml on marcosstefani/sucuri

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sucuri-1.0.4-py2.py3-none-any.whl
- Subject digest: e79a5daa42278e078120047952a4af5bb6faf56c35452ae6f0c1d29fe51ce8dc
- Sigstore transparency entry: 1566842717
- Sigstore integration time: May 18, 2026
Source repository:
- Permalink: marcosstefani/sucuri@14c658309707383e2422417839617d28e23dbaf1
- Branch / Tag: refs/tags/v1.0.4
- Owner: https://github.com/marcosstefani
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-pypi.yml@14c658309707383e2422417839617d28e23dbaf1
- Trigger Event: push

sucuri 1.0.4

Navigation

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Project description

This is a very important project.

Sucuri

Instaling

Creating a Sucuri Template

Using

Command Line Interface (CLI)

Text

Attributes

Rendering of data

Injecting template

Condition (if)

Loop (for)

Lists

Injecting Style (css) or Script (js)

Project details

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance