Metadata-Version: 2.1
Name: tiny-render
Version: 0.2.0
Summary: A tiny renderrer for replacing place holders in any text files
Home-page: https://github.com/zhongdai/tiny-render
Author: Zhong Dai
Author-email: zhongdai@gmail.com
License: UNKNOWN
Description: # Tiny Render
        
        [![Unit Testing](https://github.com/zhongdai/tiny-render/actions/workflows/tests.yml/badge.svg)](https://github.com/zhongdai/tiny-render/actions/workflows/tests.yml)
        [![Deployment](https://github.com/zhongdai/tiny-render/actions/workflows/build-and-publish.yml/badge.svg)](https://github.com/zhongdai/tiny-render/actions/workflows/build-any-publish.yml)
        [![PyPI version](https://badge.fury.io/py/tiny-render.svg)](https://badge.fury.io/py/tiny-render)
        
        *Version: 0.2.0*
        
        This is a very simple wrapper for `Jinja2` by providing few built-in variables.
        
        Additional variables for the `Template`,
        
        - `{{ _gitsha }}` - will be the shortsha for `git` hash, the value will be `None` if `git` is not
        installed or the current directory is not a git repo.
        - `{{ 'HOME' | getenv }}` - the environment variable `HOME` will be renderred. It will raise exception
        if `HOME` is not set
        - `{{ _date_str }}` - the current date in `yyyymmdd` format
        - `{{ _time_str }}` - the current date/time in `yyyymmddHHMMSS` format
        
        
        ## Installation
        
        ```bash
        pip install tiny-render
        ```
        
        Sample Code
        
        ```python
        from tiny_render import Render
        
        with open(os.path.join("/tmp","test.txt"), 'w') as f:
            f.write("gitsha: {{_gitsha}}, hello {{key}}")
        
        params = {"key": "world"}
        
        r = Render("/tmp")
        
        r.go("test.txt", **params)
        
        # the output is "gitsha: xxxxxxx, hello world"
        ```
        
        
        
Keywords: renderring template jinja2
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7.3
Description-Content-Type: text/markdown
