Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvv/templaty
Generate programming code using an elegant template language
https://github.com/samvv/templaty
Last synced: about 1 month ago
JSON representation
Generate programming code using an elegant template language
- Host: GitHub
- URL: https://github.com/samvv/templaty
- Owner: samvv
- License: mit
- Created: 2020-02-01T06:03:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T16:35:58.000Z (10 months ago)
- Last Synced: 2024-09-09T11:01:47.518Z (4 months ago)
- Language: Python
- Homepage: https://templaty.readthedocs.io/
- Size: 495 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Templaty
========
[](https://templaty.readthedocs.io/en/latest/?badge=latest)
**Templaty** is a code generator written in Python that focuses on generating
correct and readable programming code. It features fine-grained control over
whitespacing and indentation and a rich meta-language that allows full control
over the end result.
🌈 There now is [a syntax plugin for Neovim][2]!
The template syntax was inspired by [Jinja2][1] and should be very easy to pick
up.
```
def annoying_prompt():
{% for i in range(0, 5) %}
prompt("Hey, how you're doing?")
{% endfor %}
```
Generates the following code:
```python
def annoying_prompt():
prompt("Hey, how you're doing?")
prompt("Hey, how you're doing?")
prompt("Hey, how you're doing?")
prompt("Hey, how you're doing?")
prompt("Hey, how you're doing?")
```
What about generating an [identity matrix][3] in C that imposes no runtime cost?
```
static const int IDENTITY_MATRIX[][] = [
{% join i in range(0, 10) with ',' %}
[{% join j in range(0, 10) with ',' %}{% if j == i %}1{% else %}0{% endif %}{% endjoin %}]
{% endjoin %}
];
```
It should look something like this:
```c
static const int IDENTITY_MATRIX[][] = [
[1,0,0,0,0,0,0,0,0,0],
[0,1,0,0,0,0,0,0,0,0],
[0,0,1,0,0,0,0,0,0,0],
[0,0,0,1,0,0,0,0,0,0],
[0,0,0,0,1,0,0,0,0,0],
[0,0,0,0,0,1,0,0,0,0],
[0,0,0,0,0,0,1,0,0,0],
[0,0,0,0,0,0,0,1,0,0],
[0,0,0,0,0,0,0,0,1,0],
[0,0,0,0,0,0,0,0,0,1]
];
```
This is just the tip of the iceberg of what Templaty can do!
## Usage
Templaty is available on PyPi. You can issue the following command to install it:
```sh
pip3 install -U --user templaty
```
This should make the main command `templaty` available in your terminal.
This should make the main command `templaty` available in your terminal.
## IDE Integration
### Neovim
There is a [Templaty plugin][2] available
that is easy to set up.
## FAQ
### Will this library support Python 2?
No. Python 2 has reached its end-of-life and the organisation recommends
everyone to upgrade to Python 3. Porting to Python 2 requires extra work
for no good reason.
### Is it safe to use this library in my web server?
No, absolutely not! Templaty is a tool meant to be run by developers, not
end-users. As such, it has little (if any) security checks. You should never
run untrusted input using Templaty, only code you wrote yourself or from a
developer you trust.
### What extension should I use for my template files?
It is recommended to use the `.tply` extension so that syntax plugins like
[vim-templaty][2] automatically set up the right syntax highlighting for you.
If your template contains code in another programming language, simply prefix
the default file extension to `.tply`, e.g. `mytemplate.cc.tply`.
## License
Templaty is licensed under the Apache 2.0 license, in the hope it will help developers
write better programs.
[1]: https://jinja.palletsprojects.com/
[2]: https://github.com/samvv/templaty.nvim
[3]: https://en.wikipedia.org/wiki/Identity_matrix