{
"info": {
"author": "Marcos Rosa",
"author_email": "marcos.cantor@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Topic :: Software Development :: Build Tools"
],
"description": "+\n# This is a very important project.\n# Sucuri\nSimple and efficient template engine for Python projects inspired by [PugJS](https://pugjs.org)\n\n## Instaling\nInstall and update using [pip](https://pip.pypa.io/en/stable/quickstart/):\n> pip install sucuri\n\n## Creating a Sucuri Template\n- Example of code:\n```\nhtml\n body\n h1 Title\n a(href='#') This is my link\n```\nAs 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:\n```\n\n \n
Title
\n This is my link\n \n\n```\n\n## Using\nTo 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](http://flask.pocoo.org/):\n```\nfrom sucuri import rendering\nfrom flask import Flask, render_template_string\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template.suc')\n \u00a0 \u00a0return render_template_string(template)\n```\n\nAs 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. \n\n### Text\nIn sucuri, texts are described in two ways. It can be written after the declaration of the tag such as:\n```\nh1 Title\n```\nResult:\n```\n
Title
\n```\nOr you can type in more than one line using the `|` on the lines that are not the same as the tag, see example:\n```\nh3 Hello!\n | Text\n | with\n | more than\n | one line\n```\nResult:\n```\n
Hello!\n Text\n with\n more than\n one line\n
\n```\n\n### Attributes\nJust 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:\n```\na(href='google.com') Google\na(class='button' href='google.com') Google\ndiv(class='div-class')\n```\n- Result:\n```\nGoogle\nGoogle\n\n```\n\n### Rendering of data\nWe 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:\n- Sucuri file:\n```\nhtml\n body\n h1 Hello {a}\n | Title\n | More\n a(href='#') This is my link\n h3 {b}\n```\n- Python example with data:\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template_data.suc',{\"a\": 1, \"b\": \"Hello!\"})\n return render_template_string(template)\n```\n- Result:\n```\n\n \n
\n \n\n```\n\n### Injecting template\nCode 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:\n- Sucuri file (`template_include.suc`):\n```\ninclude inc/link\ninclude inc/list\n\nhtml\n body\n h1 Hello\n | Title\n | More\n +link\n h3 Oh Yeahh\n +list\n```\n- File inside the folder `inc` called `link.suc` (`inc/link.suc`):\n```\na(href='#') {text}\n```\n- File inside the folder `inc` called `list.suc` (`inc/list.suc`):\n```\nul\n li A\n li B\n```\n- Python example:\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template_include.suc',{\"text\": \"Hello! I'm here!\"})\n return render_template_string(template)\n```\n- Result:\n```\n\n \n
\n \n\n```\n\n### Condition (if)\n\nIt 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:\n- Main file\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template_if.suc',{\"x\": 1, \"y\": 3})\n return render_template_string(template)\n```\n- Sucuri file (`template_if.suc`):\n```\ninclude inc/if\n\nhtml\n body\n h1 Hello\n | Title\n | More\n +if\n```\n\n- File inside the folder `inc` called `if.suc` (`inc/if.suc`):\n```\n\nh2 The condition is True\n\n```\n- Result:\n```\n\n \n
Hello\n Title\n More\n
\n
The condtition is True
\n \n\n```\n\n### Loop (for)\nSucuri 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:\n- Main file\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template.suc',{\"text\": \"Hello! I'm here!\", \"var\":[1, 2, 3, 4]})\n return render_template_string(template)\n```\n- Sucuri file (`template_include.suc`):\n```\ninclude inc/link\ninclude inc/list\n\nhtml\n body\n h1 Hello\n | Title\n | More\n +link\n h1 Test\n +list\n```\n- File inside the folder `inc` called `link.suc` (`inc/link.suc`):\n```\na(href='#') {text}\n```\n- File inside the folder `inc` called `list.suc` (`inc/list.suc`):\n```\nul\n \n li Value #a\n h1 test\n ul\n \n li Another #w\n \n \n```\n- Result:\n```\n\n \n
\n \n\n```\n\n### Lists\n\nIt is possible to generate unordered bullet list (```
```) 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:\n- Main file\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template_list.suc',{\"items\": [1, \"two\", 3, \"Five\"], \"checked\": [1, \"Five\"]})\n return render_template_string(template)\n```\n- Sucuri file (`template_list.suc`):\n```\n\nhtml\n body\n h1 Hello\n list(items)\n list(items checked)\n```\n\n- Result:\n```\n\n \n
Hello
\n
\n
1
\n
two
\n
3
\n
Five
\n
\n 1\n two\n 3\n Five\n \n\n```\n\n`list()` also takes the optional argument `class`, which can be used to set the class of unordered lists like so:\n\n- Main file\n```\nfrom flask import Flask, render_template_string\nfrom sucuri import rendering\n\napp = Flask(__name__)\n\n@app.route(\"/\")\ndef index():\n template = rendering.template('template_list_with_classes.suc',{\"items\": [1, \"two\", 3, \"Five\"]})\n return render_template_string(template)\n```\n- Sucuri file (`template_list_with_classes.suc`):\n```\nstyle static/css/list\n\nhtml\n body\n h1 Hello\n list(items class=\"ul-squares\")\n```\n\n- Result:\n```\n\n \n
Hello
\n
\n
1
\n
two
\n
3
\n
Five
\n
\n \n\n```\n### Injecting Style (css) or Script (js)\nTo 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.\n- Sucuri file (`template.suc`):\n```\ninclude inc/link\ninclude inc/list\nstyle static/css/style\nscript static/js/script\n\nhtml\n body\n h1 Hello\n | Title\n | More\n +link\n h1 Test\n +list\n```\n\n- Include List:\n```\nstyle static/css/list\nul\n \n li Value #a\n h1(class='h1-red') test\n ul\n \n li Another #w\n \n \n```\n\n- `style` static/css/style.css\n```\nh1 {\n color: blue;\n}\n```\n\n- `style` static/css/list.css\n```\n.h1-red {\n color: red;\n}\n```\n\n- `script` static/js/script.js\n```\nfunction example() {\n console.log('test');\n}\n```\n\n- Result:\n```\n\n \n \n
![](\"https://user-images.githubusercontent.com/16294901/37826760-892cd0de-2e73-11e8-8ea1-2afc390c2ac0.png\")