https://github.com/zsarge/pyhp
Python Home Page
https://github.com/zsarge/pyhp
Last synced: about 1 year ago
JSON representation
Python Home Page
- Host: GitHub
- URL: https://github.com/zsarge/pyhp
- Owner: zsarge
- License: mit
- Created: 2023-05-26T01:57:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-18T16:08:12.000Z (almost 3 years ago)
- Last Synced: 2025-01-27T14:49:31.426Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyHP - Python Home Page
> A static site generator built using only the Python standard library, used for templating in Python.
>
> **Check out [the blog post](https://zack.fyi/blog/pyhp.html) for more information!**
The syntax is loosely based on Jinja templates:
| Syntax | Description |
| :---------: | :---------------------------------------------------------------------- |
| `{{ ... }}` | evaluates the contents of the brackets and includes the results as text |
| `{% ... %}` | executes the contents of the brackets |
All of the parsing comes from Python's built-in `eval` and `exec` statements, so there are some limitations.
For example, for loops cannot currently be spread apart in execution brackets, as Python will not be able to interpret the partial code. However, this can be worked around returning all the necessary HTML in another block.
You can find the main parser [here](https://github.com/zsarge/PyHP/blob/main/src/main.py#L11-L25).
## Basic Example
```
{% from datetime import datetime %}
{{ datetime.now().strftime("%Y-%m-%d") }}
```
when evaluated with `python3 src/main.py --file $(realpath example_site/example.php)`,
will print:
```
2023-05-25
```
## Including templates
As demonstrated in the [example site](./example_site/), it is possible to include code from partial views:
```
{{ include('./head.php') }}
```
Given that `{{ ... }}` simply includes the results of evaluated code, the `include` function simply reads a file, parses it, and returns it as a string, for use in templating.
Given these basic building blocks, it should be possible to create many types of static sites.
## Advanced example
Given the [example site](./example_site/),
```console
$ python3 src/main.py --file $(realpath example_site/index.php)
```
produces
```html
Example Document
Hello World!
Generated at 1685073812.9931087
© 2023 Zack Sargent
```
(with slightly different whitespace).
## To Do
- [x] Evaluate basic templates
- [ ] Evaluate multiple templates from a director
- [ ] Output to files / directories, instead of standard output
- [ ] Include asset management system for non-template files
- [ ] Figure out how to handle pagination
#### Inspired by [CincyPy](https://cincypy.com/)