stapler-ssg 0.1.2__tar.gz

stapler_ssg-0.1.2/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - run: pip install build
+
+      - run: python -m build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

stapler_ssg-0.1.2/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+.ruff_cache

stapler_ssg-0.1.2/Bakefile

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+serve() {
+  .venv/bin/python -m stapler serve
+}
+
+build() {
+  .venv/bin/python -m stapler build
+}
+
+format() {
+  ruff format .
+}

stapler_ssg-0.1.2/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

stapler_ssg-0.1.2/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: stapler-ssg
+Version: 0.1.2
+Summary: Simple Jinja-based static site generator
+Project-URL: Homepage, https://github.com/gijs6/stapler
+Project-URL: Repository, https://github.com/gijs6/stapler
+Author-email: Gijs6 <me@gijs6.nl>
+License: Unlicense
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: feedgen>=1.0.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: markdown>=3.5.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: watchdog>=3.0.0
+Provides-Extra: dev
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Stapler
+
+A simple static site generator built with Jinja and Markdown.
+
+## Installation
+
+Clone the repo:
+
+```bash
+git clone https://github.com/gijs6/stapler.git
+cd stapler
+```
+
+Create a virtual environment (recommended):
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install:
+
+```bash
+pip install -e .
+```
+
+Or with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick start
+
+1. Create a `stapler.toml` in your project root:
+
+```toml
+[site]
+url = "https://yoursite.com"
+title = "Your site"
+```
+
+2. Put your content in a `site/` directory (the default). Templates go in `site/templates/`.
+
+3. Run:
+
+```bash
+stapler serve   # local dev server on port 8000
+stapler build   # production build
+```
+
+## Configuration
+
+### Required
+
+```toml
+[site]
+url = "https://yoursite.com"
+title = "Your site"
+```
+
+### Optional
+
+#### Site metadata
+
+```toml
+[site]
+description = "About your site"
+base_path = "/blog"                # Deploy to example.com/blog instead of the root
+```
+
+#### Author info
+
+Used in RSS/Atom feeds.
+
+```toml
+[site.author]
+name = "Your name"
+email = "you@example.com"
+```
+
+#### Directories
+
+All paths are relative to where you run `stapler`.
+
+```toml
+[directories]
+site = "site"                      # Content directory (default: "site")
+build = "build"                    # Production output (default: "build")
+build_dev = "build-dev"            # Dev server output (default: "build-dev")
+templates = "templates"            # Templates folder inside the site directory (default: "templates")
+blog = "blog"                      # Blog posts folder inside the site directory (default: "blog")
+```
+
+#### Default template
+
+The template used for HTML pages that have front matter but no `template` field.
+
+```toml
+[templates]
+default = "base.html"
+```
+
+#### Blog
+
+```toml
+[features.blog]
+enabled = true                     # Enable blog functionality (default: false)
+template = "blog_post.html"        # Template for individual posts
+index_template = "blog_index.html" # Template for the blog index page
+```
+
+#### Sitemap and feeds
+
+```toml
+[features]
+sitemap = true                     # Generate sitemap.xml (default: true)
+
+[features.feeds]
+rss = true                         # Generate rss.xml (default: true)
+atom = true                        # Generate atom.xml (default: true)
+```
+
+Feeds are only generated when the blog feature is enabled.
+
+#### Markdown extensions
+
+```toml
+[markdown]
+extensions = ["meta", "tables", "fenced_code"]  # Python-Markdown extensions
+```
+
+## How it works
+
+### Pages
+
+Any `.html` or `.md` file in your site directory (excluding the templates and blog folders) becomes a page.
+
+#### Markdown files
+
+Markdown files are always rendered to HTML. If the front matter includes a `template` field, the result is passed to that template as `page.content`. Without a `template` field (or without front matter entirely), the raw HTML is written directly.
+
+```markdown
+---
+template: base.html
+title: My page
+---
+
+# Content
+
+Regular markdown here
+```
+
+#### HTML files
+
+HTML files with front matter are rendered through a template. The `template` field in front matter takes precedence; if omitted, the default template from `[templates].default` is used.
+
+```html
+---
+title: My page
+---
+<h1>Content here</h1>
+```
+
+HTML files without front matter are treated as Jinja templates directly:
+
+```html
+{% extends "base.html" %}
+{% block content %}
+<h1>Hello</h1>
+{% endblock %}
+```
+
+Front matter is YAML. All fields are available as `page.metadata.<field>` in your templates.
+
+#### Static files
+
+Anything that's not a `.html` or `.md` file (and not in your templates or blog folder) is copied as-is to the output directory.
+
+### Blog
+
+Enable the blog feature in your config, then put `.md` files in your blog directory.
+
+```markdown
+---
+title: My post
+date: 2025-01-15
+---
+
+Post content here
+```
+
+The `date` field is optional. If omitted, stapler tries to infer it from the file's git history.
+
+### Templates
+
+Templates live in the directory you configured (default: `site/templates/`).
+
+#### Available in all templates
+
+- `data`: build info
+  - `data.now`: current build time
+    - `data.now.date.long`: date as `%B %d, %Y` (e.g. `April 12, 2026`)
+    - `data.now.date.short`: date as `%Y-%m-%d` (e.g. `2026-04-12`)
+    - `data.now.time`: time as `%H:%M:%S`
+    - `data.now.iso`: datetime as ISO 8601
+  - `data.last_commit`: last git commit info (`None` if not in a git repo)
+    - `data.last_commit.hash.short`: short 7-character commit hash
+    - `data.last_commit.hash.long`: full commit hash
+    - `data.last_commit.dt.date.long`: date as `%B %d, %Y` (e.g. `April 12, 2026`)
+    - `data.last_commit.dt.date.short`: date as `%Y-%m-%d` (e.g. `2026-04-12`)
+    - `data.last_commit.dt.time`: time as `%H:%M:%S`
+    - `data.last_commit.dt.iso`: datetime as ISO 8601
+
+#### Regular page templates
+
+- `page`: the current page
+  - `page.active_page`: identifier derived from the filename (e.g. `about` for `about.html`, `home` for `index.html`), useful for highlighting the active nav item
+  - `page.canonical_path`: URL path of the page (e.g. `/about`)
+  - `page.content`: page content as HTML (only present if the page has front matter)
+  - `page.metadata.<field>`: any front matter field (e.g. `page.metadata.title`)
+
+#### Blog post template
+
+- `page`: navigation info
+  - `page.active_page`: name of the blog directory (e.g. `blog`)
+  - `page.canonical_path`: URL path of the post (e.g. `/blog/my-post`)
+- `post`: the current blog post
+  - `post.title`: post title (from front matter, or derived from the filename)
+  - `post.slug`: URL slug (filename without `.md`)
+  - `post.content`: post content as HTML
+  - `post.date`: date as `%Y-%m-%d` (e.g. `2026-04-12`), only set if a date is available
+  - `post.date_iso`: date as ISO 8601, only set if a date is available
+- `data`: same as above
+
+#### Blog index template
+
+- `page`: navigation info
+  - `page.active_page`: name of the blog directory (e.g. `blog`)
+  - `page.canonical_path`: URL path of the blog index (e.g. `/blog`)
+- `posts`: list of all blog posts sorted newest first; each item has the same fields as `post` above
+- `data`: same as above
+
+## CLI
+
+```bash
+# Build with default config (stapler.toml)
+stapler build
+
+# Build with custom config
+stapler build -c myconfig.toml
+
+# Serve on default port (8000)
+stapler serve
+
+# Serve on custom port
+stapler serve -p 3000
+
+# Serve with custom config and port
+stapler serve -c myconfig.toml -p 3000
+
+# Show version
+stapler --version
+```

stapler_ssg-0.1.2/README.md

@@ -0,0 +1,264 @@
+# Stapler
+
+A simple static site generator built with Jinja and Markdown.
+
+## Installation
+
+Clone the repo:
+
+```bash
+git clone https://github.com/gijs6/stapler.git
+cd stapler
+```
+
+Create a virtual environment (recommended):
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install:
+
+```bash
+pip install -e .
+```
+
+Or with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick start
+
+1. Create a `stapler.toml` in your project root:
+
+```toml
+[site]
+url = "https://yoursite.com"
+title = "Your site"
+```
+
+2. Put your content in a `site/` directory (the default). Templates go in `site/templates/`.
+
+3. Run:
+
+```bash
+stapler serve   # local dev server on port 8000
+stapler build   # production build
+```
+
+## Configuration
+
+### Required
+
+```toml
+[site]
+url = "https://yoursite.com"
+title = "Your site"
+```
+
+### Optional
+
+#### Site metadata
+
+```toml
+[site]
+description = "About your site"
+base_path = "/blog"                # Deploy to example.com/blog instead of the root
+```
+
+#### Author info
+
+Used in RSS/Atom feeds.
+
+```toml
+[site.author]
+name = "Your name"
+email = "you@example.com"
+```
+
+#### Directories
+
+All paths are relative to where you run `stapler`.
+
+```toml
+[directories]
+site = "site"                      # Content directory (default: "site")
+build = "build"                    # Production output (default: "build")
+build_dev = "build-dev"            # Dev server output (default: "build-dev")
+templates = "templates"            # Templates folder inside the site directory (default: "templates")
+blog = "blog"                      # Blog posts folder inside the site directory (default: "blog")
+```
+
+#### Default template
+
+The template used for HTML pages that have front matter but no `template` field.
+
+```toml
+[templates]
+default = "base.html"
+```
+
+#### Blog
+
+```toml
+[features.blog]
+enabled = true                     # Enable blog functionality (default: false)
+template = "blog_post.html"        # Template for individual posts
+index_template = "blog_index.html" # Template for the blog index page
+```
+
+#### Sitemap and feeds
+
+```toml
+[features]
+sitemap = true                     # Generate sitemap.xml (default: true)
+
+[features.feeds]
+rss = true                         # Generate rss.xml (default: true)
+atom = true                        # Generate atom.xml (default: true)
+```
+
+Feeds are only generated when the blog feature is enabled.
+
+#### Markdown extensions
+
+```toml
+[markdown]
+extensions = ["meta", "tables", "fenced_code"]  # Python-Markdown extensions
+```
+
+## How it works
+
+### Pages
+
+Any `.html` or `.md` file in your site directory (excluding the templates and blog folders) becomes a page.
+
+#### Markdown files
+
+Markdown files are always rendered to HTML. If the front matter includes a `template` field, the result is passed to that template as `page.content`. Without a `template` field (or without front matter entirely), the raw HTML is written directly.
+
+```markdown
+---
+template: base.html
+title: My page
+---
+
+# Content
+
+Regular markdown here
+```
+
+#### HTML files
+
+HTML files with front matter are rendered through a template. The `template` field in front matter takes precedence; if omitted, the default template from `[templates].default` is used.
+
+```html
+---
+title: My page
+---
+<h1>Content here</h1>
+```
+
+HTML files without front matter are treated as Jinja templates directly:
+
+```html
+{% extends "base.html" %}
+{% block content %}
+<h1>Hello</h1>
+{% endblock %}
+```
+
+Front matter is YAML. All fields are available as `page.metadata.<field>` in your templates.
+
+#### Static files
+
+Anything that's not a `.html` or `.md` file (and not in your templates or blog folder) is copied as-is to the output directory.
+
+### Blog
+
+Enable the blog feature in your config, then put `.md` files in your blog directory.
+
+```markdown
+---
+title: My post
+date: 2025-01-15
+---
+
+Post content here
+```
+
+The `date` field is optional. If omitted, stapler tries to infer it from the file's git history.
+
+### Templates
+
+Templates live in the directory you configured (default: `site/templates/`).
+
+#### Available in all templates
+
+- `data`: build info
+  - `data.now`: current build time
+    - `data.now.date.long`: date as `%B %d, %Y` (e.g. `April 12, 2026`)
+    - `data.now.date.short`: date as `%Y-%m-%d` (e.g. `2026-04-12`)
+    - `data.now.time`: time as `%H:%M:%S`
+    - `data.now.iso`: datetime as ISO 8601
+  - `data.last_commit`: last git commit info (`None` if not in a git repo)
+    - `data.last_commit.hash.short`: short 7-character commit hash
+    - `data.last_commit.hash.long`: full commit hash
+    - `data.last_commit.dt.date.long`: date as `%B %d, %Y` (e.g. `April 12, 2026`)
+    - `data.last_commit.dt.date.short`: date as `%Y-%m-%d` (e.g. `2026-04-12`)
+    - `data.last_commit.dt.time`: time as `%H:%M:%S`
+    - `data.last_commit.dt.iso`: datetime as ISO 8601
+
+#### Regular page templates
+
+- `page`: the current page
+  - `page.active_page`: identifier derived from the filename (e.g. `about` for `about.html`, `home` for `index.html`), useful for highlighting the active nav item
+  - `page.canonical_path`: URL path of the page (e.g. `/about`)
+  - `page.content`: page content as HTML (only present if the page has front matter)
+  - `page.metadata.<field>`: any front matter field (e.g. `page.metadata.title`)
+
+#### Blog post template
+
+- `page`: navigation info
+  - `page.active_page`: name of the blog directory (e.g. `blog`)
+  - `page.canonical_path`: URL path of the post (e.g. `/blog/my-post`)
+- `post`: the current blog post
+  - `post.title`: post title (from front matter, or derived from the filename)
+  - `post.slug`: URL slug (filename without `.md`)
+  - `post.content`: post content as HTML
+  - `post.date`: date as `%Y-%m-%d` (e.g. `2026-04-12`), only set if a date is available
+  - `post.date_iso`: date as ISO 8601, only set if a date is available
+- `data`: same as above
+
+#### Blog index template
+
+- `page`: navigation info
+  - `page.active_page`: name of the blog directory (e.g. `blog`)
+  - `page.canonical_path`: URL path of the blog index (e.g. `/blog`)
+- `posts`: list of all blog posts sorted newest first; each item has the same fields as `post` above
+- `data`: same as above
+
+## CLI
+
+```bash
+# Build with default config (stapler.toml)
+stapler build
+
+# Build with custom config
+stapler build -c myconfig.toml
+
+# Serve on default port (8000)
+stapler serve
+
+# Serve on custom port
+stapler serve -p 3000
+
+# Serve with custom config and port
+stapler serve -c myconfig.toml -p 3000
+
+# Show version
+stapler --version
+```

stapler_ssg-0.1.2/example_site/.gitignore

@@ -0,0 +1,2 @@
+build/
+build-dev/

stapler_ssg-0.1.2/example_site/site/about.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block content %}
+<h1>about</h1>
+<p>this is the about page</p>
+{% endblock %}

stapler_ssg-0.1.2/example_site/site/assets/styles/custom.css

@@ -0,0 +1,25 @@
+body {
+    font-family: system-ui, sans-serif;
+    line-height: 1.6;
+    max-width: 800px;
+    margin: 0 auto;
+    padding: 20px;
+}
+
+nav {
+    margin-bottom: 40px;
+}
+
+nav a {
+    margin-right: 20px;
+}
+
+article {
+    margin-bottom: 40px;
+}
+
+footer {
+    margin-top: 80px;
+    padding-top: 20px;
+    border-top: 1px solid #ccc;
+}

stapler_ssg-0.1.2/example_site/site/blog/getting-started.md

@@ -0,0 +1,26 @@
+---
+title: getting started
+date: 2025-01-16
+---
+
+# getting started with stapler
+
+here's how to get started with your own stapler site.
+
+## create a config
+
+create `stapler.toml`:
+
+```toml
+[site]
+url = "https://yoursite.com"
+title = "your site"
+```
+
+## add content
+
+create a `site/` folder and put your content there. that's it!
+
+## build
+
+run `stapler build` to build your site, or `stapler serve` for a dev server.

stapler_ssg-0.1.2/example_site/site/blog/welcome-to-stapler.md

@@ -0,0 +1,19 @@
+---
+title: welcome to stapler
+date: 2025-01-15
+---
+
+# welcome to stapler
+
+this is the first example blog post. stapler is a simple static site generator built with python.
+
+## features
+
+- jinja2 templating
+- markdown support
+- blog with rss/atom feeds
+- dev server with live reload
+
+## getting started
+
+check out the [README](https://github.com/gijs6/stapler) for installation instructions.

stapler_ssg-0.1.2/example_site/site/index.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block content %}
+<h1>welcome to stapler</h1>
+<p>this is an example site built with stapler</p>
+{% endblock %}