Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamstackpy/jamstack
The easiest way to create jamstack sites with the Power of Python and Flask, as simple or as complex as you like.
https://github.com/jamstackpy/jamstack
flask jamstack static-site-generator
Last synced: 1 day ago
JSON representation
The easiest way to create jamstack sites with the Power of Python and Flask, as simple or as complex as you like.
- Host: GitHub
- URL: https://github.com/jamstackpy/jamstack
- Owner: jamstackpy
- License: apache-2.0
- Created: 2021-08-22T18:39:27.000Z (over 3 years ago)
- Default Branch: stable
- Last Pushed: 2023-05-01T12:18:06.000Z (almost 2 years ago)
- Last Synced: 2025-01-17T00:15:58.308Z (13 days ago)
- Topics: flask, jamstack, static-site-generator
- Language: HTML
- Homepage: https://jamstackpy.github.io/
- Size: 1.23 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOGS.md
- License: LICENSE
Awesome Lists containing this project
README
Also known as Jamstackpy, is a tool that allows you to create static websites using the power of **Python** hand in hand
with the [Flask](https://github.com/pallets/flask) library. Its operation is based on templates which are rendered with
the powerful Jinja engine generating your website with all its dependencies.
## Installation
```bash
python -m pip install jamstack
```
## Create basic project
```bash
jamstack plain
```
## Templates
Jamstack has templates available courtesy of [html5up](https://html5up.net).
| Template | Command | Tutorial |
|--------------------------------------------|-------------------|--------------------------------------------------------------------------|
| [Massively](https://html5up.net/massively) | html5up/massively | |
| [Phantom](https://html5up.net/phantom) | html5up/phantom | [**HERE**](https://github.com/jamstackpy/jamstack/wiki/Phantom-template) |
The syntax is as follows:
```bash
jamstack t
```
Use the `--existing` flag if you want the project to be created in an existing folder
```bash
jamstack t html5up/massively myproject --existing
```
By default, projects based in templates are created without the assets (stylesheets, images, etc...) to download them,
you must pass
the `--jamdo` option to the `static.py` file of the respective project.
## Build
To build the site run the file `static.py`.
```bash
python static.py
```
Your site will be generated in the **dist/** folder.
## Other project command-line options
| Argument | Description |
|-----------|---------------------------------------------------------------------------|
| `--serve` | Optional. Start project livewatch (autoreload when files change). |
| `--watch` | Optional. Specify files and folders to watch. Must be separated by comma. |
| `--port` | Optional. Specify server port. |
## Sites using jamstack
- [DeliciousPy Telegram Channel](https://deliciouspy.github.io/)
- [The Flask Community Work Group](https://flaskcwg.github.io/)
- [Abdur-Rahmaan Janhangeer](https://compileralchemy.github.io/)
# TODO
- [ ] Replace `python static.py --serve/--jamdo` by something like `jamstack --serve/--jamdo`
- [ ] Remove Flask as Main requirement and just use Jinja