Nicer URLs, refs simonw#34

Author: simonw

.github/workflows/build.yml

@@ -47,7 +47,7 @@ jobs:
     - name: Download previous database unless REBUILD in commit message
       if: |-
         !contains(github.event.head_commit.message, 'REBUILD')
-      run: curl --fail -o main/til.db https://raw.githubusercontent.com/simonw/til-db/main/til.db
+      run: curl --fail -o main/tils.db https://raw.githubusercontent.com/simonw/til-db/main/tils.db
       continue-on-error: true
     - name: Build database
       run: |-
@@ -74,11 +74,11 @@ jobs:
         git config --global user.name "README-bot"
         git diff --quiet || (git add README.md && git commit -m "Updated README")
         git push
-    - name: Save til.db to simonw/til-db
+    - name: Save tils.db to simonw/til-db
       run: |-
         cd til-db
-        cp ../main/til.db .
-        git add til.db
+        cp ../main/tils.db .
+        git add tils.db
         git commit --amend --no-edit
         git push --force
     - name: Setup Node.js
@@ -90,7 +90,7 @@ jobs:
         NOW_TOKEN: ${{ secrets.NOW_TOKEN }}
       run: |-
         cd main
-        datasette publish now til.db \
+        datasette publish now tils.db \
           --token $NOW_TOKEN \
           --branch main \
           --project simon-til \

build_database.py

@@ -35,13 +35,14 @@ def created_changed_times(repo_path, ref="main"):
 
 def build_database(repo_path):
     all_times = created_changed_times(repo_path)
-    db = sqlite_utils.Database(repo_path / "til.db")
+    db = sqlite_utils.Database(repo_path / "tils.db")
     table = db.table("til", pk="path")
     for filepath in root.glob("*/*.md"):
         fp = filepath.open()
         title = fp.readline().lstrip("#").strip()
         body = fp.read().strip()
         path = str(filepath.relative_to(root))
+        slug = filepath.stem
         url = "https://github.com/simonw/til/blob/main/{}".format(path)
         # Do we need to render the markdown?
         path_slug = path.replace("/", "_")
@@ -54,13 +55,15 @@ def build_database(repo_path):
             previous_html = None
         record = {
             "path": path_slug,
+            "slug": slug,
             "topic": path.split("/")[0],
             "title": title,
             "url": url,
             "body": body,
         }
         if (body != previous_body) or not previous_html:
             retries = 0
+            response = None
             while retries < 3:
                 headers = {}
                 if os.environ.get("GITHUB_TOKEN"):

generate_screenshots.py

@@ -11,6 +11,7 @@
     (root / "templates" / "til_base.html"),
 ]
 
+
 def png_for_path(path):
     page_html = str(TMP_PATH / "generate-screenshots-page.html")
     # Use datasette to generate HTML
@@ -33,7 +34,7 @@ def png_for_path(path):
 
 
 def generate_screenshots(root):
-    db = sqlite_utils.Database(root / "til.db")
+    db = sqlite_utils.Database(root / "tils.db")
 
     # The shot_hash incorporates a hash of all of row.html
 
@@ -47,7 +48,7 @@ def generate_screenshots(root):
         html = row["html"]
         shot_hash = hashlib.md5((shot_html_hash + html).encode("utf-8")).hexdigest()
         if shot_hash != row.get("shot_hash"):
-            png = png_for_path("/til/til/{}".format(path))
+            png = png_for_path("/tils/til/{}".format(path))
             db["til"].update(path, {"shot": png, "shot_hash": shot_hash}, alter=True)
             print(
                 "Got {} byte PNG for {} shot hash {}".format(len(png), path, shot_hash)

github-actions/continue-on-error.md

@@ -6,14 +6,14 @@ I wanted to have a GitHub Action step run that might fail, but if it failed the
 
 ```yaml
     - name: Download previous database
-      run: curl --fail -o til.db https://til.simonwillison.net/til.db
+      run: curl --fail -o tils.db https://til.simonwillison.net/tils.db
       continue-on-error: true
     - name: Build database
       run: python build_database.py
 ```
 
 [From this workflow](https://github.com/simonw/til/blob/7d799a24921f66e585b8a6b8756b7f8040c899df/.github/workflows/build.yml#L32-L36)
 
-I'm using `curl --fail` here which returns an error code if the file download files (without `--fail` it was writing out a two line error message to a file called `til.db` which is not what I wanted). Then `continue-on-error: true` to keep on going even if the download failed.
+I'm using `curl --fail` here which returns an error code if the file download files (without `--fail` it was writing out a two line error message to a file called `tils.db` which is not what I wanted). Then `continue-on-error: true` to keep on going even if the download failed.
 
-My `build_database.py` script updates the `til.db` database file if it exists and creates it from scratch if it doesn't.
+My `build_database.py` script updates the `tils.db` database file if it exists and creates it from scratch if it doesn't.

metadata.yaml

@@ -8,7 +8,7 @@ plugins:
     screenshot:
       "sql": "select shot as content, 'image/png' as content_type from til where path=:key"
 databases:
-  til:
+  tils:
     queries:
       search: |
         select
@@ -21,7 +21,7 @@ databases:
         where
           til_fts match case
             :q
-            when '' then '*'
+            when '' then 'nomatchforthisterm'
             else escape_fts(:q)
           end
         order by
@@ -32,7 +32,7 @@ databases:
           SELECT
             'tag:til.simonwillison.net,2020-04-30:' || path as atom_id,
             title as atom_title,
-            'https://til.simonwillison.net/til/til/' || path as atom_link,
+            'https://til.simonwillison.net/' || topic || '/' || slug as atom_link,
             created_utc as atom_updated,
             html as atom_content_html,
             'Simon Willison' as atom_author_name,

plugins/redirects.py

@@ -0,0 +1,17 @@
+from datasette import hookimpl
+from datasette.utils.asgi import Response
+
+
+@hookimpl
+def register_routes():
+    return (
+        ("^/til/feed.atom$", lambda: Response.redirect("/tils/feed.atom", status=301)),
+        (
+            "^/til/search$",
+            lambda request: Response.redirect(
+                "/tils/search"
+                + (("?" + request.query_string) if request.query_string else ""),
+                status=301,
+            ),
+        ),
+    )

requirements.txt

@@ -1,10 +1,9 @@
 GitPython
 sqlite-utils>=2.19
 beautifulsoup4
-datasette
+datasette>=0.51.1
 datasette-atom>=0.7
 datasette-publish-now>=0.6
 datasette-template-sql>=1.0
 datasette-graphql
 datasette-media
-httpx

templates/index.html

@@ -4,7 +4,7 @@
 
 {% block extra_head %}
 <link href="https://github.com/simonw" rel="me">
-<link rel="alternate" type="application/atom+xml" title="Atom" href="/til/feed.atom">
+<link rel="alternate" type="application/atom+xml" title="Atom" href="/tils/feed.atom">
 <style>
 input[type=search] {
     padding: .25em;
@@ -35,7 +35,7 @@
 <h1>Simon Willison: TIL</h1>
 <p>Things I've learned, collected in <a href="https://github.com/simonw/til">simonw/til</a>.</p>
 
-<p><a style="text-decoration: none" href="/til/feed.atom" title="Atom feed"><svg xmlns="http://www.w3.org/2000/svg" width="14px" height="14px" viewBox="0 0 256 256">
+<p><a style="text-decoration: none" href="/tils/feed.atom" title="Atom feed"><svg xmlns="http://www.w3.org/2000/svg" width="14px" height="14px" viewBox="0 0 256 256">
     <defs>
     <linearGradient id="a" x1=".1" x2=".9" y1=".1" y2=".9">
         <stop offset="0" stop-color="#E3702D" />
@@ -55,9 +55,9 @@ <h1>Simon Willison: TIL</h1>
 <path fill="#FFF" d="M184 213A140 140 0 0 0 44 73V38a175 175 0 0 1 175 175z" />
     </svg> Atom feed</a></p>
 
-<p><strong>Recently added:</strong> {% for row in sql("select * from til order by created_utc desc limit 5") %}<a href="/til/til/{{ row.path }}">{{ row.title }}</a>{% if not loop.last %}, {% endif %}{% endfor %}</p>
+<p><strong>Recently added:</strong> {% for row in sql("select * from til order by created_utc desc limit 5") %}<a href="/{{ row.topic }}/{{ row.slug }}">{{ row.title }}</a>{% if not loop.last %}, {% endif %}{% endfor %}</p>
 
-<form action="/til/search">
+<form action="/tils/search">
     <p>
         <input type="search" name="q" placeholder="Search {{ sql("select count(*) from TIL")[0][0] }} TILs">
         <input type="submit" value="Search">
@@ -68,7 +68,7 @@ <h1>Simon Willison: TIL</h1>
     <h2>{{ row.topic }}</h2>
     <ul>
         {% for til in sql("select * from til where topic = :topic order by created_utc desc", {"topic": row.topic}) %}
-            <li><a href="/til/til/{{ til.path }}">{{ til.title }}</a> - {{ til.created[:10] }}</li>
+            <li><a href="/{{ til.topic }}/{{ til.slug }}">{{ til.title }}</a> - {{ til.created[:10] }}</li>
         {% endfor %}
     </ul>
 {% endfor %}

templates/pages/{topic}.html

@@ -0,0 +1,24 @@
+{% extends "til_base.html" %}
+
+{% set tils = sql("""
+    select * from til where topic = :topic order by created_utc
+""", {"topic": topic})
+%}
+
+{% block title %}Simon Willison: TILs on {{ topic }}{% endblock %}<!DOCTYPE html>
+
+{% block body %}
+
+{% if not tils %}
+    {{ raise_404("No TILs found") }}
+{% endif %}
+
+<h1>Simon Willison: TILs on {{ topic }}</h1>
+
+<ul>
+{% for til in tils %}
+    <li><a href="/{{ til.topic }}/{{ til.slug }}">{{ til.title }}</a> - {{ til.created[:10] }}</li>
+{% endfor %}
+</ul>
+
+{% endblock %}

templates/pages/{topic}/{slug}.html

@@ -0,0 +1,38 @@
+{% extends "til_base.html" %}
+
+{% set tils = sql("""
+    select * from til where path = :topic || '_' || :slug || '.md'
+""", {"topic": topic, "slug": slug})
+%}
+{% set til = tils[0] %}
+{% if not tils %}
+    {% set raised = raise_404("TIL not found") %}
+{% endif %}
+
+{% block title %}{{ til.title }} | Simon Willison’s TILs{% endblock %}
+
+{% block extra_head %}
+<link rel="stylesheet" href="/static/github-light.css">
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:creator" content="@simonw">
+<meta name="twitter:title" content="{{ til.title }}">
+<meta name="twitter:description" content="{{ til.body }}">
+<meta name="twitter:image" content="https://til.simonwillison.net/-/media/screenshot/{{ til.path }}">
+<meta name="twitter:image:alt" content="Screenshot of this article">
+<meta property="og:url" content="https://til.simonwillison.net/til/til/{{ til.path }}">
+<meta property="og:type" content="article">
+<meta property="og:title" content="{{ til.title }}">
+<meta property="og:description" content="{{ til.body }}">
+<meta property="og:image" content="https://til.simonwillison.net/-/media/screenshot/{{ til.path }}">
+<meta property="og:image:alt" content="Screenshot of this article">
+<meta property="og:image:width" content="800">
+<meta property="og:image:height" content="400">
+{% endblock %}
+
+{% block body %}
+<h1>{{ til.title }}</h1>
+
+{{ til.html|safe }}
+
+<p class="created">Created {{ til.created }}{% if til.created != til.updated %}, updated {{ til.updated }} &middot; <a href="{{ til.url|replace("https://github.com/simonw/til/blob/", "https://github.com/simonw/til/commits/") }}">History</a>{% endif %} &middot; <a href="{{ til.url }}">Edit</a></p>
+{% endblock %}

templates/query-til-search.html renamed to templates/query-tils-search.html

@@ -45,7 +45,7 @@
 {% block body %}
 <h1>TIL search: {{ q }}</h1>
 
-<form action="/til/search">
+<form action="/tils/search">
     <p>
         <input type="search" name="q" value="{{ q }}">
         <input type="submit" value="Search">
@@ -57,7 +57,7 @@ <h1>TIL search: {{ q }}</h1>
 {% endif %}
 
 {% for row in rows %}
-    <p><span class="topic">{{ row.topic }}</span> <a href="/til/til/{{ row.path }}">{{ row.title }}</a> - {{ row.created[:10] }}</p>
+    <p><span class="topic">{{ row.topic }}</span> <a href="/{{ row.topic }}/{{ row.slug }}">{{ row.title }}</a> - {{ row.created[:10] }}</p>
     <pre>{{ highlight(row.snippet)|safe }}</pre>
 {% endfor %}
 

update_readme.py

@@ -1,4 +1,4 @@
-"Run this after build_database.py - it needs til.db"
+"Run this after build_database.py - it needs tils.db"
 import pathlib
 import sqlite_utils
 import sys
@@ -12,7 +12,7 @@
 COUNT_TEMPLATE = "<!-- count starts -->{}<!-- count ends -->"
 
 if __name__ == "__main__":
-    db = sqlite_utils.Database(root / "til.db")
+    db = sqlite_utils.Database(root / "tils.db")
     by_topic = {}
     for row in db["til"].rows_where(order_by="created_utc"):
         by_topic.setdefault(row["topic"], []).append(row)