jamstack 1.0.0__tar.gz → 2.0.0__tar.gz

jamstack-2.0.0/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.{md,py,txt}]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

jamstack-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on:
+  push:
+    branches: [stable, "2.0"]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install ruff
+      - run: ruff check .
+      - run: ruff format --check .
+
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest --cov --cov-report=term-missing
+
+  commits:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install commitizen
+      - run: cz check --rev-range origin/${{ github.base_ref }}..HEAD
+
+  docs:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[dev]"
+      - run: zensical build --strict

jamstack-2.0.0/.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[dev]" build
+      - run: ruff check .
+      - run: ruff format --check .
+      - run: pytest
+      - name: Check version matches tag
+        run: |
+          python -c "import jamstack, os; assert jamstack.__version__ == os.environ['GITHUB_REF_NAME'].lstrip('v'), jamstack.__version__"
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

jamstack-2.0.0/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.idea/
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+/dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Local tooling
+.venv/
+.ruff_cache/
+site/

jamstack-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.19.3
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]

jamstack-2.0.0/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## 2.0.0 (2026-11-07)
+
+### Breaking
+
+- The engine was rewritten. Projects built with `settings.py`, `static.py` or
+  the html5up themes must migrate to `site.toml` and `content/`; see
+  [the migration guide](docs/migration.md).
+- Python 3.11 or newer is required.
+- The html5up themes are no longer bundled or downloaded. 2.0 ships its own
+  `minimal` and `blog` themes.
+
+### Features
+
+- `jamstack init` creates a site from a bundled theme.
+- `site.toml` configures the title, description, author, base URL, output
+  directory and theme.
+- Markdown and Jinja pages in `content/` use TOML front matter and map to clean
+  URLs.
+- `jamstack build` renders every page through Jinja with strict undefined
+  handling and copies the theme and project static files.
+- Themes are discovered from the bundled set and from `themes/` in the project;
+  templates and static files can be overridden per project.
+- `jamstack themes` lists the available themes and their origin.
+- `jamstack serve` serves the output over HTTP and rebuilds when a source
+  changes.
+- `sitemap.xml` and an Atom `feed.xml` are generated when `base_url` is set,
+  and themes can provide a `404.html`.
+
+### Bug fixes
+
+- `serve` keeps watching after a failed rebuild.
+- `serve` flushes status messages when output is redirected.
+
+## 1.1.0
+
+* Bulk refactors and code documentation
+* New commands for `static.py` files
+    * `--serve` for livewatch changes
+    * `--watch` for watch specific files and folders.
+    * `--port` especiffy serve port
+
+## 1.0.0
+
+* Back to namespace method for write templates names
+    * Example: `html5up/massively` instead of just `massively`
+* Template assets are not included in the library to minimize the size of the library, they were moved to
+  a [separate repository](https://github.com/jamstackpy/jamstack-templates).
+
+## 0.1.0
+
+* Improve **Plain** template
+* Add new templates (massively, phantom)
+* When creating a project, instead of writing the template like this: **html5up/massively**, you can use the name
+  directly, i.e. **massively**
+* The assets of each template are now included in the library
+
+## 0.0.4
+
+* Add README.md info
+
+## 0.0.3
+
+* Add plain template
+
+## 0.0.1
+
+* Initial release

jamstack-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing
+
+## Development setup
+
+```bash
+git clone git@github.com:jamstackpy/jamstack.git
+cd jamstack
+git switch stable
+python -m venv .venv
+. .venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+Run the checks before opening a pull request:
+
+```bash
+ruff check .
+ruff format --check .
+pytest
+```
+
+## Commits
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/) in
+English:
+
+```
+feat(cli): add a --drafts flag to build
+fix(content): reject dates without a year
+docs: explain local theme overrides
+```
+
+One commit is one reviewable intention. Do not mix unrelated changes under a
+message that only describes one of them, and do not leave intermediate commits
+that fail the tests. Mechanical changes (renames, formatting, dependency
+bumps) go in their own commit.
+
+Write a body when the change needs context: bullet points, in English,
+explaining what and why. `commitizen` validates the message through the
+`commit-msg` hook installed above.
+
+## Pull requests
+
+- Target the `stable` branch.
+- Include a test for new behaviour; bug fixes should include the case that
+  reproduces the bug.
+- Keep user-facing strings and documentation in English.
+- Do not rewrite pushed history.
+
+## Releasing
+
+Publishing runs on tags through GitHub Actions and PyPI trusted publishing,
+with no API tokens stored anywhere.
+
+One-time setup:
+
+1. On PyPI, open the `jamstack` project → Publishing → add a GitHub publisher
+   with owner `jamstackpy`, repository `jamstack`, workflow `release.yml`, and
+   environment `pypi`.
+2. On GitHub, create an environment named `pypi` in the repository settings.
+
+Releases use `cz bump`. It updates `src/jamstack/__about__.py`, rewrites
+`CHANGELOG.md`, commits the result, and creates the tag in one step:
+
+```bash
+cz bump --increment patch   # or minor, major
+git push origin stable
+git push origin v<version>
+```
+
+The `Release` workflow runs on tags matching `v*` and fails if the tag does not
+match `src/jamstack/__about__.py`. Pre-releases work the same way with
+`cz bump --prerelease rc`.
+
+Review the generated section before pushing the tag. It is a draft: keep only
+user-visible changes, list breaking changes first, and fix the wording.

jamstack-2.0.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.5
+Name: jamstack
+Version: 2.0.0
+Summary: Static site generator built on Python and Jinja
+Project-URL: Homepage, https://github.com/jamstackpy/jamstack
+Project-URL: Source, https://github.com/jamstackpy/jamstack
+Project-URL: Issues, https://github.com/jamstackpy/jamstack/issues
+Project-URL: Changelog, https://github.com/jamstackpy/jamstack/blob/stable/CHANGELOG.md
+Author-email: Abdur-Rahmaan Janhangeer <arj.python@gmail.com>, Pedro Torcatt <pedrotorcattsoto@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: jinja,python,ssg,static site generator
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: jinja2>=3.1
+Requires-Dist: markdown-it-py>=3.0
+Provides-Extra: dev
+Requires-Dist: commitizen>=4.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.17; extra == 'dev'
+Requires-Dist: zensical>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img alt="Jamstack logo" src="https://i.imgur.com/sXUAdYJ.png" height="217" />
+
+  <p>A small static site generator built on Python and Jinja.</p>
+</div>
+
+[![CI](https://github.com/jamstackpy/jamstack/actions/workflows/ci.yml/badge.svg?branch=stable)](https://github.com/jamstackpy/jamstack/actions/workflows/ci.yml)
+![PyPI](https://img.shields.io/pypi/v/jamstack)
+![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)
+
+## Documentation
+
+The full documentation lives in [`docs/`](docs/) and is built with Zensical.
+Preview it locally with `zensical serve`; it is published at
+<https://jamstackpy.github.io/>.
+
+Jamstack turns a folder of Markdown and Jinja templates into a static site.
+There is no database, no runtime, and no network access during a build: you
+write content, run one command, and deploy the generated `dist/` folder
+anywhere.
+
+## Features
+
+- Markdown pages with TOML front matter, or raw Jinja templates when you need
+  full control.
+- Themes as plain folders: bundled ones, your own, or a per-project override.
+- A development server that rebuilds on change and keeps the last good build
+  when something fails.
+- `sitemap.xml`, an Atom feed, and a themed `404.html` generated for you.
+- Deterministic output: the same sources always produce the same bytes.
+- Three runtime dependencies: `click`, `jinja2`, `markdown-it-py`.
+
+## Installation
+
+```bash
+python -m pip install jamstack
+```
+
+Python 3.11 or newer is required.
+
+## Quick start
+
+```bash
+jamstack init my-site --theme blog
+cd my-site
+jamstack build
+jamstack serve
+```
+
+`jamstack init` scaffolds `site.toml`, a starter page, and the files the chosen
+theme needs. `jamstack build` writes the site to `dist/`. `jamstack serve`
+serves it at `http://127.0.0.1:8000` and rebuilds when a source changes.
+
+## Project layout
+
+```
+my-site/
+  site.toml          # site configuration
+  content/           # pages (.md or .html)
+  static/            # files copied as-is to the output root
+  templates/         # optional overrides of the theme's templates
+  themes/            # optional local themes
+  dist/              # build output (do not edit)
+```
+
+## Writing content
+
+A page is a file under `content/`. Its path becomes its URL:
+
+| Source | URL | Output |
+| --- | --- | --- |
+| `content/index.md` | `/` | `dist/index.html` |
+| `content/about.md` | `/about/` | `dist/about/index.html` |
+| `content/posts/hello.md` | `/posts/hello/` | `dist/posts/hello/index.html` |
+
+Markdown files may start with TOML front matter delimited by `+++`:
+
+```markdown
++++
+title = "Hello, world"
+date = 2026-11-06
+summary = "The first post."
++++
+
+This is **Markdown**.
+```
+
+Recognised keys:
+
+| Key | Type | Meaning |
+| --- | --- | --- |
+| `title` | string | Page title. Defaults to the file name. |
+| `date` | ISO date | Publication date. Feeds and listings order by it. |
+| `template` | string | Template to render the page with. |
+| `draft` | boolean | Excluded from builds unless `--drafts` is passed. |
+| `summary` | string | Short description used by feeds and the blog theme. |
+
+Any other key is available to templates as `page.meta`. Files ending in
+`.html` are rendered as Jinja templates instead of Markdown, which makes it
+easy to build landing pages with custom markup.
+
+## Configuration
+
+```toml
+[site]
+title = "My Site"                 # required
+description = ""
+author = ""
+base_url = "https://example.com"  # required for sitemap.xml and feed.xml
+language = "en"
+
+[build]
+output = "dist"
+
+[theme]
+name = "blog"
+```
+
+`base_url` must be the public, absolute URL of the site. When it is set,
+Jamstack writes `sitemap.xml` with every page and `feed.xml` with every dated
+page. When it is empty, both files are skipped rather than emitting relative
+URLs.
+
+## Themes
+
+List the available themes with:
+
+```bash
+jamstack themes
+```
+
+Two themes ship with the package: `minimal` for small sites and `blog` for
+dated posts. A project can override a bundled theme by creating
+`themes/<name>/` inside the project; local themes take precedence.
+
+Themes are plain folders, so a custom theme is just a directory with a
+`theme.toml`, `templates/`, and optionally `static/` and `scaffold/`. See
+[docs/themes.md](docs/themes.md) for the full specification.
+
+## Command reference
+
+| Command | Description |
+| --- | --- |
+| `jamstack init [PATH] [--theme NAME] [--force]` | Create a new site. |
+| `jamstack build [--clean] [--drafts]` | Build the site into `dist/`. |
+| `jamstack serve [--port PORT] [--drafts]` | Build, serve, and rebuild on change. |
+| `jamstack themes` | List available themes. |
+| `jamstack --version` | Print the installed version. |
+
+`python -m jamstack` behaves like the `jamstack` command.
+
+## Migrating from 1.x
+
+The 1.x engine (`settings.py`, `posts.json`, `static.py`, html5up themes) is
+replaced entirely in 2.0. See [docs/migration.md](docs/migration.md) for a
+step-by-step conversion guide, or keep using 1.x with:
+
+```bash
+python -m pip install "jamstack<2"
+```
+
+## Development
+
+```bash
+git clone git@github.com:jamstackpy/jamstack.git
+cd jamstack
+git switch stable
+python -m venv .venv
+. .venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install --hook-type pre-commit --hook-type commit-msg
+pytest
+```
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/);
+see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT. The 1.x html5up templates were distributed under CC BY 3.0 and are no
+longer part of this branch.