ryland 0.1.0__tar.gz

ryland-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: ryland
+Version: 0.1.0
+Summary: A simple static site generation library
+Author: James Tauber
+Author-email: James Tauber <jtauber@jtauber.com>
+License-Expression: MIT
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: markdown>=3.8.2
+Requires-Dist: pyyaml>=6.0.2
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Ryland
+
+A simple static site generation library
+
+
+## Current Features
+
+- Jinja2 templates and a basic markdown filter
+- copying static files and directory trees (for stylesheets, scripts, fonts, images)
+- cache-busting with hashes
+
+
+## History
+
+I've generally found most static site generation libraries to either be far too complex for my needs or be too restricted to just blogs so, over the years, I've generated many static sites with lightweight, bespoke Python code and hosted them on GitHub pages. However, I've ended up repeating myself a lot so I'm now cleaning it all up and generalizing my prior work as this library.
+
+
+## Example Usage
+
+For now, clone this repo and use as an editable requirement.
+
+Write a build script of the following form:
+
+```python
+from ryland import Ryland
+
+ROOT_DIR = Path(__file__).parent.parent
+DIST_DIR = ROOT_DIR / "dist"
+PANTRY_DIR = ROOT_DIR / "pantry"
+TEMPLATE_DIR = ROOT_DIR / "templates"
+
+ryland = Ryland(dist_dir=DIST_DIR, template_dir=TEMPLATE_DIR)
+
+ryland.clear_dist()
+ryland.copy_to_dist(PANTRY_DIR / "style.css")
+ryland.calc_hash("style.css")
+
+ryland.render_template("404.html", "404.html")
+ryland.render_template("about_us.html", "about-us/index.html")
+
+# construct context variables
+
+ryland.render_template("homepage.html", "index.html", {
+    # context variables
+})
+```
+
+## Cache-Busting Hashes
+
+The `calc_hash` makes it possible to do
+
+```html
+<link rel="stylesheet" href="/style.css?{{ HASHES['style.css'] }}">
+```
+
+in the templates.
+
+
+## Markdown Filter
+
+To render a markdown context variable:
+
+```
+{{ content | markdown }}
+```
+
+## Sites Currently Using Ryland
+
+- <https://projectamaze.com>
+
+
+## Roadmap
+
+- move over other sites to use Ryland
+- incorporate more common elements that emerge
+- produce a Ryland-generated website for Ryland
+- document how to automatically build with GitHub actions
+- write up a cookbook
+- add a command-line too for starting a Ryland-based site
+

ryland-0.1.0/README.md

@@ -0,0 +1,80 @@
+# Ryland
+
+A simple static site generation library
+
+
+## Current Features
+
+- Jinja2 templates and a basic markdown filter
+- copying static files and directory trees (for stylesheets, scripts, fonts, images)
+- cache-busting with hashes
+
+
+## History
+
+I've generally found most static site generation libraries to either be far too complex for my needs or be too restricted to just blogs so, over the years, I've generated many static sites with lightweight, bespoke Python code and hosted them on GitHub pages. However, I've ended up repeating myself a lot so I'm now cleaning it all up and generalizing my prior work as this library.
+
+
+## Example Usage
+
+For now, clone this repo and use as an editable requirement.
+
+Write a build script of the following form:
+
+```python
+from ryland import Ryland
+
+ROOT_DIR = Path(__file__).parent.parent
+DIST_DIR = ROOT_DIR / "dist"
+PANTRY_DIR = ROOT_DIR / "pantry"
+TEMPLATE_DIR = ROOT_DIR / "templates"
+
+ryland = Ryland(dist_dir=DIST_DIR, template_dir=TEMPLATE_DIR)
+
+ryland.clear_dist()
+ryland.copy_to_dist(PANTRY_DIR / "style.css")
+ryland.calc_hash("style.css")
+
+ryland.render_template("404.html", "404.html")
+ryland.render_template("about_us.html", "about-us/index.html")
+
+# construct context variables
+
+ryland.render_template("homepage.html", "index.html", {
+    # context variables
+})
+```
+
+## Cache-Busting Hashes
+
+The `calc_hash` makes it possible to do
+
+```html
+<link rel="stylesheet" href="/style.css?{{ HASHES['style.css'] }}">
+```
+
+in the templates.
+
+
+## Markdown Filter
+
+To render a markdown context variable:
+
+```
+{{ content | markdown }}
+```
+
+## Sites Currently Using Ryland
+
+- <https://projectamaze.com>
+
+
+## Roadmap
+
+- move over other sites to use Ryland
+- incorporate more common elements that emerge
+- produce a Ryland-generated website for Ryland
+- document how to automatically build with GitHub actions
+- write up a cookbook
+- add a command-line too for starting a Ryland-based site
+

ryland-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "ryland"
+version = "0.1.0"
+description = "A simple static site generation library"
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "James Tauber", email = "jtauber@jtauber.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "jinja2>=3.1.6",
+    "markdown>=3.8.2",
+    "pyyaml>=6.0.2",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.14,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.12.11",
+]

ryland-0.1.0/src/ryland/__init__.py

@@ -0,0 +1 @@
+from .core import *

ryland-0.1.0/src/ryland/core.py

@@ -0,0 +1,60 @@
+from hashlib import md5
+from os import makedirs
+from shutil import copy, copytree, rmtree
+
+import jinja2
+import markdown
+
+
+class Ryland:
+    def __init__(self, dist_dir, template_dir):
+        self.dist_dir = dist_dir
+        self.template_dir = template_dir
+        self.hashes = {}
+
+        self.jinja_env = jinja2.Environment(
+            loader=jinja2.FileSystemLoader(template_dir)
+        )
+        self.jinja_env.filters["markdown"] = markdown_filter
+
+    def clear_dist(self):
+        for child in self.dist_dir.iterdir():
+            if child.is_dir():
+                rmtree(child)
+            else:
+                child.unlink()
+
+    def copy_to_dist(self, source):
+        if source.is_dir():
+            dest = self.dist_dir / source.name
+            copytree(source, dest, dirs_exist_ok=True)
+        else:
+            copy(source, self.dist_dir / source.name)
+
+    def calc_hash(self, filename):
+        self.hashes[filename] = make_hash(self.dist_dir / filename)
+
+    def render_template(self, template_name, output_filename, context=None):
+        context = context or {}
+        template = self.jinja_env.get_template(template_name)
+        output_path = self.dist_dir / output_filename
+        makedirs(output_path.parent, exist_ok=True)
+        with open(output_path, "w") as f:
+            f.write(
+                template.render(
+                    {
+                        "HASHES": self.hashes,
+                        **context,
+                    }
+                )
+            )
+
+
+def make_hash(path):
+    hasher = md5()
+    hasher.update(path.read_bytes())
+    return hasher.hexdigest()
+
+
+def markdown_filter(text):
+    return markdown.markdown(text, extensions=["fenced_code", "codehilite", "tables"])