picata 0.0.1__tar.gz

picata-0.0.1/.gitignore

@@ -0,0 +1,29 @@
+.env
+secrets.tfvars
+
+.venv/
+node_modules/
+
+.terraform
+terraform.tfstate
+terraform.tfstate.*
+terraform.tfstate.d/
+infra/dot_env.tfvars
+
+build/
+lib/
+media/
+static/
+!src/picata/static/
+src/db.sqlite3
+snapshots/*.tgz
+
+logs/
+*.log
+
+__pycache__
+*.swp
+.junk/
+.DS_Store
+
+.dmypy.json

picata-0.0.1/LICENSE.md

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2024` `Ada Wright <ada@hpk.io>`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT
+HOLDERS 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.

picata-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: picata
+Version: 0.0.1
+Summary: Ada's Wagtail-based CMS & blog
+Project-URL: Documentation, https://github.com/hipikat/picata#readme
+Project-URL: Issues, https://github.com/hipikat/picata/issues
+Project-URL: Source, https://github.com/hipikat/picata
+Author-email: Ada Wright <ada@hpk.io>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: blog,cms,django,wagtail
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Django CMS
+Classifier: Framework :: Wagtail :: 6
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.13
+Requires-Dist: gunicorn~=23.0.0
+Requires-Dist: lxml~=5.3.0
+Requires-Dist: psutil~=6.1.0
+Requires-Dist: psycopg~=3.2.3
+Requires-Dist: pygments~=2.18.0
+Requires-Dist: python-slugify~=8.0.4
+Requires-Dist: wagtail-modeladmin~=2.1.0
+Requires-Dist: wagtail~=6.2
+Description-Content-Type: text/markdown
+
+# Ada's website
+
+Wherein I set up a little website, and learn a bunch of stuff as I go.
+
+## What it's made of
+
+### Inside the box
+
+- [Wagtail](https://wagtail.org) (on [Django](https://www.djangoproject.com)) is the web framework
+<!-- - [Tailwind CSS](https://tailwindcss.com) for styling -->
+
+### Holding things together
+
+- [UV](https://github.com/astral-sh/uv) for all Python project management
+- [Just](https://just.systems) as a command runner
+- [OpenTofu](https://opentofu.org) for DevOps
+- [Postgres](https://www.postgresql.org) for the database
+- [Docker](https://www.docker.com) for local development
+
+## Quickstart
+
+### Requirements
+
+- On a Mac:
+
+```shell
+brew install colima docker
+```
+
+### Run a development server
+
+```shell
+just tofu workspace select dev
+just tofu apply
+```
+
+This will spin up a box on DigitalOcean using the settings defined in
+[infra/variables.tf](infra/variables.tf), and create a DNS A record at
+(workspace).for.(tld), (i.e. dev.for.hpk.io) pointing to the box. The variables
+`do_token` and `ssh_fingerprint` should be defined in
+[infra/secrets.tfvars](infra/secrets.tfvars). Workspace-specific variables are
+defined in infra/envs/(workspace).tfvars; e.g.
+[infra/envs/dev.tfvars](infra/envs/dev.tfvars) defines the 'tags' list for the
+box as `[development]` and sets `cloud_init_config` to point to the
+[cloud-init](https://cloud-init.io) script
+[config/cloud-init-dev.yml](config/cloud-init-dev.yml).
+
+The development cloud-init script will:
+
+- Install the system packages [`just`](https://just.systems), [`zsh`](https://www.zsh.org),
+  [`gunicorn`](https://gunicorn.org), and `tree`
+- Create a 'wagtail' user, with UID 1500
+- Create the 'ada' user, and:
+  - install their SSH public keys,
+  - install their dotfiles,
+  - add them to the 'sudo' and 'wagtail' groups
+- Install [Node](http://nodejs.org) on the system, from the `TF_VAR_NODE_VERSION`
+  defined in [.env](.env)
+- Checkout this repository into `/app`, setting the owner and group to 'wagtail'.

picata-0.0.1/README.md

@@ -0,0 +1,59 @@
+# Ada's website
+
+Wherein I set up a little website, and learn a bunch of stuff as I go.
+
+## What it's made of
+
+### Inside the box
+
+- [Wagtail](https://wagtail.org) (on [Django](https://www.djangoproject.com)) is the web framework
+<!-- - [Tailwind CSS](https://tailwindcss.com) for styling -->
+
+### Holding things together
+
+- [UV](https://github.com/astral-sh/uv) for all Python project management
+- [Just](https://just.systems) as a command runner
+- [OpenTofu](https://opentofu.org) for DevOps
+- [Postgres](https://www.postgresql.org) for the database
+- [Docker](https://www.docker.com) for local development
+
+## Quickstart
+
+### Requirements
+
+- On a Mac:
+
+```shell
+brew install colima docker
+```
+
+### Run a development server
+
+```shell
+just tofu workspace select dev
+just tofu apply
+```
+
+This will spin up a box on DigitalOcean using the settings defined in
+[infra/variables.tf](infra/variables.tf), and create a DNS A record at
+(workspace).for.(tld), (i.e. dev.for.hpk.io) pointing to the box. The variables
+`do_token` and `ssh_fingerprint` should be defined in
+[infra/secrets.tfvars](infra/secrets.tfvars). Workspace-specific variables are
+defined in infra/envs/(workspace).tfvars; e.g.
+[infra/envs/dev.tfvars](infra/envs/dev.tfvars) defines the 'tags' list for the
+box as `[development]` and sets `cloud_init_config` to point to the
+[cloud-init](https://cloud-init.io) script
+[config/cloud-init-dev.yml](config/cloud-init-dev.yml).
+
+The development cloud-init script will:
+
+- Install the system packages [`just`](https://just.systems), [`zsh`](https://www.zsh.org),
+  [`gunicorn`](https://gunicorn.org), and `tree`
+- Create a 'wagtail' user, with UID 1500
+- Create the 'ada' user, and:
+  - install their SSH public keys,
+  - install their dotfiles,
+  - add them to the 'sudo' and 'wagtail' groups
+- Install [Node](http://nodejs.org) on the system, from the `TF_VAR_NODE_VERSION`
+  defined in [.env](.env)
+- Checkout this repository into `/app`, setting the owner and group to 'wagtail'.

picata-0.0.1/components/HelloWorld.tsx

@@ -0,0 +1,11 @@
+import React from "react";
+
+type Props = {
+  name: string;
+};
+
+const HelloWorld: React.FC<Props> = ({ name }) => {
+  return <h1>Hello, {name}!</h1>;
+};
+
+export default HelloWorld;

picata-0.0.1/entrypoint.tsx

@@ -0,0 +1,268 @@
+import "./styles.sass";
+
+const THEMES = {
+  light: "fl",
+  dark: "ad",
+};
+
+// Set listeners on data-set-theme attributes to change the theme
+import { themeChange } from "theme-change";
+themeChange();
+
+//
+// Theme "reset to system defaults", and "light"/"dark" data-theme-mode logic
+//
+function initializeThemeReset() {
+  const themeReset = document.querySelector<HTMLSpanElement>("#theme-reset");
+  const themeButtons = document.querySelectorAll<HTMLButtonElement>("[data-set-theme]");
+
+  const updateThemeMode = () => {
+    const theme = document.documentElement.getAttribute("data-theme");
+    if (theme === THEMES.dark || theme === THEMES.light) {
+      document.documentElement.setAttribute(
+        "data-theme-mode",
+        theme === THEMES.dark ? "dark" : "light",
+      );
+    } else {
+      const prefersDark = window.matchMedia("(prefers-color-scheme: dark)").matches;
+      document.documentElement.setAttribute("data-theme-mode", prefersDark ? "dark" : "light");
+    }
+  };
+
+  const updateThemeResetButtonVisibility = () => {
+    if (themeReset) {
+      const isThemeSet = document.documentElement.hasAttribute("data-theme");
+      if (isThemeSet) {
+        themeReset.classList.remove("hidden", "pointer-events-none");
+      } else {
+        themeReset.classList.add("hidden", "pointer-events-none");
+      }
+    }
+  };
+
+  // Initialize on page load
+  updateThemeMode();
+  updateThemeResetButtonVisibility();
+
+  // Add a listener for system preference changes
+  const prefersDarkQuery = window.matchMedia("(prefers-color-scheme: dark)");
+  prefersDarkQuery.addEventListener("change", () => {
+    if (!document.documentElement.getAttribute("data-theme")) {
+      updateThemeMode();
+    }
+  });
+
+  // Monitor changes to the data-theme attribute
+  const themeChangeObserver = new MutationObserver(() => {
+    updateThemeMode();
+    updateThemeResetButtonVisibility();
+  });
+  themeChangeObserver.observe(document.documentElement, {
+    attributes: true,
+    attributeFilter: ["data-theme"],
+  });
+
+  // Add click listener for the reset button
+  if (themeReset) {
+    themeReset.addEventListener("click", () => {
+      document.documentElement.removeAttribute("data-theme");
+      localStorage.removeItem("theme");
+
+      themeButtons.forEach((button) => {
+        button.classList.remove("btn-active");
+      });
+
+      updateThemeMode();
+      updateThemeResetButtonVisibility();
+    });
+  } else {
+    console.error("Could not find #theme-reset element.");
+  }
+
+  // Add listeners to theme buttons to toggle "btn-active" class
+  themeButtons.forEach((button) => {
+    button.addEventListener("click", () => {
+      const newTheme = button.getAttribute("data-set-theme");
+      if (newTheme) {
+        document.documentElement.setAttribute("data-theme", newTheme);
+        localStorage.setItem("theme", newTheme);
+      }
+
+      themeButtons.forEach((btn) => btn.classList.remove("btn-active"));
+      button.classList.add("btn-active");
+
+      updateThemeMode();
+    });
+  });
+}
+
+//
+// Search field toggling logic
+//
+function initializeSearchFieldToggle() {
+  const searchToggleButton = document.getElementById("search-toggle") as HTMLButtonElement | null;
+  const searchField = document.getElementById("search-field") as HTMLElement | null;
+
+  if (!searchToggleButton || !searchField) {
+    console.error("Search toggle or search field elements not found.");
+    return;
+  }
+
+  searchToggleButton.addEventListener("click", () => {
+    const isVisible = searchField.classList.toggle("search-visible");
+    searchField.classList.toggle("search-hidden", !isVisible);
+    searchField.setAttribute("tabindex", isVisible ? "0" : "-1");
+    searchToggleButton.classList.toggle("!rounded-r-none", isVisible);
+    searchToggleButton.classList.toggle("!rounded-r-full", !isVisible);
+    searchToggleButton.setAttribute("aria-expanded", isVisible.toString());
+    if (isVisible) {
+      searchField.focus();
+    }
+  });
+}
+
+//
+// Apply shadows to the right of code blocks when they overflow their container
+//
+function initializeCodeBlockOverflowWatchers(): void {
+  const pygmentsDivs: NodeListOf<HTMLDivElement> = document.querySelectorAll(".pygments");
+
+  const applyOverflowClass = (div: HTMLDivElement) => {
+    const pre = div.querySelector("pre");
+    if (!pre) return;
+
+    if (pre.scrollWidth > pre.clientWidth) {
+      div.classList.add("shadow-fade-right");
+    } else {
+      div.classList.remove("shadow-fade-right");
+    }
+  };
+
+  // Apply initial shadows
+  pygmentsDivs.forEach(applyOverflowClass);
+
+  // Add resize listener to recheck on window resize
+  window.addEventListener("resize", () => {
+    pygmentsDivs.forEach(applyOverflowClass);
+  });
+}
+
+//
+// Create the nested list of internal page links for a 'Page Contents' container
+//
+function renderPageContents(): void {
+  const tocContainer = document.querySelector("main nav .toc");
+  if (!tocContainer) return;
+
+  // Create the header for the navigation
+  const tocHeader = document.createElement("h2");
+  tocHeader.textContent = "In this page";
+  tocContainer.appendChild(tocHeader);
+
+  // Create the root list
+  const tocList = document.createElement("ul");
+  tocContainer.appendChild(tocList);
+
+  // Stack to track the current list level
+  const listStack: HTMLUListElement[] = [tocList];
+  let currentLevel = 1;
+
+  // Find all anchor-linked headings
+  const headings = document.querySelectorAll<HTMLElement>(
+    "h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]",
+  );
+  headings.forEach((heading) => {
+    const headingLevel = parseInt(heading.tagName.substring(1)); // Extract the heading level (e.g., "1" for "H1")
+
+    // Adjust the stack to match the heading level
+    while (headingLevel > currentLevel) {
+      // Create intermediate sub-lists for skipped levels
+      const newList = document.createElement("ul");
+      const lastItem = listStack[listStack.length - 1].lastElementChild;
+
+      if (lastItem) {
+        lastItem.appendChild(newList);
+        listStack.push(newList);
+      } else {
+        // If no previous item exists, append directly to the current list
+        listStack[listStack.length - 1].appendChild(newList);
+        listStack.push(newList);
+      }
+      currentLevel++;
+    }
+
+    while (headingLevel < currentLevel) {
+      // Pop back to the parent list
+      listStack.pop();
+      currentLevel--;
+    }
+
+    // Add the heading to the current list
+    const listItem = document.createElement("li");
+    const link = document.createElement("a");
+
+    // Get heading text without pilcrow
+    link.href = `#${heading.id}`;
+    link.textContent = heading.textContent?.replace("¶", "").trim() || "Untitled"; // Remove pilcrow
+    listItem.appendChild(link);
+
+    listStack[listStack.length - 1].appendChild(listItem);
+  });
+}
+
+// function enableStickyTOC(): void {
+//   const tocContainer = document.querySelector<HTMLElement>(".toc > div");
+//   if (!tocContainer) return;
+
+//   const parentContainer = tocContainer.parentElement;
+//   if (!parentContainer) return;
+
+//   const offsetTop = 16; // Equivalent to Tailwind's `top-4`
+//   const marginRight = 16; // Equivalent to Tailwind's `-mr-4`
+
+//   const initialTop = parentContainer.getBoundingClientRect().top + window.scrollY;
+//   const parentStyles = getComputedStyle(parentContainer);
+
+//   window.addEventListener("scroll", () => {
+//     const currentScroll = window.scrollY;
+//     const stickyStart = initialTop - offsetTop;
+
+//     if (currentScroll >= stickyStart) {
+//       tocContainer.classList.add("is-fixed");
+
+//       tocContainer.style.position = "fixed";
+//       tocContainer.style.top = `${offsetTop}px`;
+//       tocContainer.style.maxHeight = `calc(100vh - ${offsetTop}px)`;
+//       tocContainer.style.overflowY = "auto";
+
+//       // Dynamically calculate width and right offset
+//       const parentWidth = parentContainer.getBoundingClientRect().width;
+//       tocContainer.style.width = `${parentWidth}px`;
+//       tocContainer.style.padding = parentStyles.padding; // Preserve padding
+//       tocContainer.style.right = `${marginRight}px`; // Apply negative right margin
+//     } else {
+//       tocContainer.classList.remove("is-fixed");
+
+//       tocContainer.style.position = "relative";
+//       tocContainer.style.top = "initial";
+//       tocContainer.style.maxHeight = "initial";
+//       tocContainer.style.overflowY = "initial";
+
+//       // Reset dynamically applied styles
+//       tocContainer.style.width = "initial";
+//       tocContainer.style.padding = "initial";
+//       tocContainer.style.right = "initial"; // Reset right offset
+//     }
+//   });
+// }
+
+//
+// Main DOMContentLoaded Listener
+//
+document.addEventListener("DOMContentLoaded", () => {
+  initializeThemeReset();
+  initializeSearchFieldToggle();
+  initializeCodeBlockOverflowWatchers();
+  renderPageContents();
+  // enableStickyTOC();
+});

picata-0.0.1/manage.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+"""Entry-point for Django management commands."""
+
+from os import environ
+from sys import argv
+
+if __name__ == "__main__":
+    environ.setdefault("DJANGO_SETTINGS_MODULE", "hpk.settings.dev")
+
+    if len(argv) >= 2:  # noqa: PLR2004
+        environ.setdefault("DJANGO_MANAGEMENT_COMMAND", argv[1])
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(argv)

picata-0.0.1/picata/__init__.py

@@ -0,0 +1 @@
+"""Main "umbrella" package for custom code running hpk.io."""

picata-0.0.1/picata/apps.py

@@ -0,0 +1,33 @@
+"""Application configuration for the hpk Django app."""
+
+from django.apps import AppConfig
+
+
+class Config(AppConfig):
+    """Configuration class for the hpk Django application."""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "hpk"
+
+    def ready(self) -> None:
+        """Configure Wagtail admin with custom models, and register document transformers."""
+        #
+        # Register the 'custom article type' model with the Wagtail admin
+        from wagtail_modeladmin.options import modeladmin_register
+
+        from hpk.models import ArticleTypeAdmin
+
+        modeladmin_register(ArticleTypeAdmin)
+
+        # Add document transformers to the HTMLProcessingMiddleware
+        from hpk.middleware import HTMLProcessingMiddleware
+        from hpk.transformers import AnchorInserter, add_heading_ids
+
+        ## Add ids to all headings missing them within html > body > main
+        HTMLProcessingMiddleware.add_transformer(add_heading_ids)
+
+        ## Add anchored pillcrows to headings in designated pages
+        anchor_inserter = AnchorInserter(
+            root="//main/article", targets=".//h1 | .//h2 | .//h3 | .//h4 | .//h5 | .//h6"
+        )
+        HTMLProcessingMiddleware.add_transformer(anchor_inserter)