Skip to main content

TAL Chameleon (static site generator)

Project description

talqual

Test Coverage Pypi Python version Gplv3-License

TAL Chameleon static site generator.

Simple structure: templates + data -> output html

Installation

Install from PyPI:

pip install talqual

Developing

Install requirement and launch tests:

pip install -r requirements-dev.txt
pytest tests

Selenium

Launch tests with driver option:

pytest tests --driver firefox

Maybe you get the error:

selenium.common.exceptions.WebDriverException: Message: 'geckodriver' executable needs to be in PATH.

Then you need to download the latest geckodriver release from https://github.com/mozilla/geckodriver/releases (such as geckodriver-v0.28.0-linux64.tar.gz) and extract it to the correspongind directory (such as /usr/local/bin/).

Usage

  • talqual templates_dir

  • talqual templates_dir output_html –data data_dir

  • python -m talqual templates_dir output_html –data data_dir

or from code:

from talqual.main import build
build(templates_dir, html_dir, data_dir)

Features

Template elements: Folder, File, TalTemplate/Html, NoView, TalCommand Data elements: Python objects, Folder, yaml, json, rst

  • Define a data directory. Will be converted to dictionary structure:

    • Subfolders

    • Yaml files

    • Json files

    • ReestructuredText files (only variables)

  • Define a templates directory

  • A folder in the templates is created to the html directory

  • A file (pdf, image, css, js, etc.) in the templates is copied to the html directory

  • A no view element (file or directory starting by _) in the templates is not created to the html directory

  • A TAL template in the templates gets rendered to the html directory

    • It can reference data from the data directory or from python objects

    • It can be:

      • a static .html or .htm (with no templating)

      • a simple template .html .htm or .pt (with TAL templating, see TALsyntax)

      • a template with macros .html .htm or .pt (with TAL and METAL templating, see METALsyntax)

  • A TAL Command gets executed and rendered to the html directory

    • a template with NAME.tal_repeat_VARIABLE.pt gets repeated by data[VARIABLE] (it must be an iterable such as [ITEM0, ITEM1, ITEM2, …] ). Results in NAME.0.html, NAME.1.html, NAME.2.html, etc.

      • a template with tal.tal_repeat_VARIABLE.pt results in ITEM0.html, ITEM1.html, ITEM2.html, etc.

      • inside each TAL template the expression ${tal_repeat_VARIABLE} can be used. Contains the current index ${tal_repeat_VARIABLE.num} and ITEM ${tal_repeat_VARIABLE.item}.

    • a template with NAME.tal_batch_VARIABLE_PAGESIZE.pt gets rendered by a Batch of PAGESIZE for data[VARIABLE] (it must be an iterable). Results in NAME.html, NAME.2.html, NAME.3.html, etc.

    • a template with NAME.tal_replace_talqual_scripts.js gets rendered to a javascript file NAME.js with the faceted module.

    • a template with NAME.tal_replace_DATA:VARIABLE.js gets rendered to the contents of file in data[DATA][VARIABLE].

    • VARIABLE can be generally expressed as VAR1:VAR2:VAR3 meaning data[VAR1][VAR2][VAR3]

  • Inside TAL templates, there is the expression url: for computing links relatively to the root. For example: href=”${url: static/a.png}”

  • HTML internal links integrity is checked. In case of broken links, a warning is shown when building.

Extra

  • A template can include the faceted javascript module. See the portfolio example.

  • A template can include the calendar javascript module. See the portfolio example.

Translation (i18n)

See the i18n example.

Install:

  • You need to pip install babel-lingua-chameleon or pip install talqual[multilingual]

Usage:

  • talqual templates_dir (by default locales at templates_dir/_locales)

  • talqual templates_dir output_html –data data_dir –locales locales_dir

Features:

  • Define a folder in the templates named tal_.tal_repeat_LOCALES

  • Define templates .html .htm or .pt with TAL templating that includes i18n, see TALi18nsyntax.

  • Define inside data a LOCALES variable listing the enabled localizations (l10n). For exemple, a data.yaml:

    LOCALES:
    - ca
    - en
    - oc
  • Define the locales_dir. Recommended with Babel command-line interface

    • First time:

      • Define the babel.cfg to extract from TAL templates:

        [python: **.py]
        [lingua-chameleon: **.html]
        [lingua-chameleon: **.htm]
        [lingua-chameleon: **.pt]
      • mkdir locales

      • pybabel extract -F babel.cfg -o locales/mydomain.pot .

      • pybabel init -D mydomain -i locales/mydomain.pot -d locales -l ca

      • (init all languages)

      • pybabel compile -D mydomain -d locales

    • Updates:

      • pybabel extract -F babel.cfg -o locales/mydomain.pot .

      • pybabel update -D mydomain -i locales/mydomain.pot -d locales

      • pybabel compile -D mydomain -d locales

License

talqual is offered under the GPLv3 license.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

CHANGES

0.0.4 (2023-4-16)

  • Fix parsing empty folders

0.0.3 (2023-4-15)

  • Add data structure: template structure + data structure = output html

  • Add TAL templating i18n features

  • Add context variable tal_repeat when repeating commands

  • Add url: expression for TAL templates

  • Manage static Files with hard links.

0.0.2 (2020-4-7)

  • Add faceted select features

  • Add faceted+batch combination

0.0.1 (2020-2-2)

  • Initial release.

  • Template structure + yaml data file = output html structure

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

talqual-0.0.4-py3-none-any.whl (40.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page