Newer
Older
.. image:: https://git.shore.co.il/nimrod/template/badges/master/pipeline.svg
:target: https://git.shore.co.il/nimrod/template/-/commits/master
.. image:: https://img.shields.io/pypi/l/template.svg
:target: http://www.gnu.org/licenses/agpl-3.0.en.html
:alt: Project license
.. image:: https://img.shields.io/pypi/dd/template.svg
:target: https://pypistats.org/packages/template
:alt: PyPI Stats
.. image:: https://img.shields.io/pypi/implementation/template.svg
:alt: Supported Python implementations
.. image:: https://img.shields.io/pypi/pyversions/template.svg
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/v/template.svg
:target: https://pypi.org/project/template/
:alt: Latest version on PyPI
A CLI tool for generating files from `Jinja2 <http://jinja.pocoo.org/>`_
Installation
------------
.. code:: shell
pip install template[all]
This will install Template along with the dependencies for all of the filters
available with it. However, you can use narrower specifiers if you want to avoid
a specifc dependency (the filters listed below include the needed specifier).
In previous versions of Template all of the dependencies were required, so to
avoid breakage this behavior will be be kept. However, this will change in a
later release so the keep the expected behavior please update your project's
dependencies.
Examples
--------
$ template -h
usage: template [-h] [-o OUTPUT] [filename]
A CLI tool for generating files from Jinja2 templates and environment
variables.
positional arguments:
filename Input filename
optional arguments:
-h, --help show this help message and exit
-o OUTPUT, --output OUTPUT
Output to filename
$ export name='John'
$ echo 'Hello {{ name if name is defined else 'world' }}. | template
Hello John.
$ echo '{{ USER }}' > username.j2
$ template --output username.txt username.j2
Jinja filters
-------------
The following Jinja filters were added:
- :code:`to_yaml`: Convert to yaml (requires the :code:`yaml` package
specifier).
- :code:`from_yaml`: Convert from yaml (requires the :code:`yaml` package
specifier).
- :code:`to_json`: Convert to json.
- :code:`from_json`: Convert from json.
- :code:`to_toml`: Convert to toml (requires the :code:`toml` package
specifier).
- :code:`from_toml`: Convert from toml (requires the :code:`toml` package
specifier).
- :code:`jmespath`: Queries data using the `JMESPath <http://jmespath.org/>`_
query language (requires the :code:`jmespath` package specifier).
- :code:`run`: Runs a command and returns the stdout, stderr and returncode
using `run
<https://docs.python.org/3.6/library/subprocess.html?highlight=popen#subprocess.run>`_.
Example usage can be seen in :code:`tests` and for specific filters in the
docstrings in :code:`template/filters.py`.
Tests require Pipenv_ and
`Bats <https://github.com/bats-core/bats-core>`_. Run the tests with the
following commands:
.. code:: shell
pipenv run lint # Pre-commit hooks.
pipenv run doctest # Doc tests.
pipenv run bats # Bats tests.
Also, GitLab CI is setup for this project so every push to this repository is
checked with all Python 2.7, Python 3.6 and later and all supported versions of
PyPy.
Release requires Pipenv_. To bump the version run
:code:`pipenv run bumpversion major|minor|patch` to update the version and git
commit and tag the changes, then run :code:`git push --follow-tags` to push the
git commit and tag. The GitLab CI will then build and upload a release to PyPI.
To manually upload to PyPI run :code:`pipenv run build` to build the Python
package and :code:`pipenv run upload -s dist/*` to upload a signed version.
License
-------
This software is licensed under the AGPL 3+ license (see the :code:`LICENSE.txt`
file).
Author
------
Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located