wip: initial commit

Author: agoose77

.github/workflows/deploy.yml

@@ -0,0 +1,50 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines the website is served from, including CSS & JS assets
+  # You may need to change this to `BASE_URL: ''`
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12' 
+      - name: Install MyST Markdown
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./_build/html"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+_build

README.md

@@ -0,0 +1,2 @@
+# MyST Python Plugin
+An example of deploying a MyST book that uses a Python Plugin

content/index.md

@@ -0,0 +1,7 @@
+# Python Plugin
+
+$\sin(2\pi) + \cos(2\pi)$ is:
+
+```{calc}
+sin(pi*2) + cos(pi*2)
+```

myst.yml

@@ -0,0 +1,15 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  title: Python Plugin
+  references:
+    guide: https://mystmd.org/guide
+  plugins:
+    - type: executable
+      path: ./plugin.py
+  toc:
+    - file: content/index.md
+site:
+  template: book-theme
+  options:
+    logo_text: Python Plugin

plugin.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+import argparse
+import json
+import sys
+
+
+plugin = {
+    "name": "Calculator",
+    "directives": [
+        {
+            "name": "calc",
+            "doc": "An example directive for running Python expressions.",
+            "body": {
+                "type": "string",
+                "doc": "The expression to compute",
+            },
+        }
+    ],
+}
+
+
+def declare_result(content):
+    """Declare result as JSON to stdout
+
+    :param content: content to declare as the result
+    """
+
+    # Format result and write to stdout
+    json.dump(content, sys.stdout, indent=2)
+    # Successfully exit
+    raise SystemExit(0)
+
+
+def run_directive(name, data):
+    """Execute a directive with the given name and data
+
+    :param name: name of the directive to run
+    :param data: data of the directive to run
+    """
+    assert name == "calc"
+
+    # Run user program
+    result = eval(data["body"], {**globals(), **vars(__import__("math"))})
+    result = {"type": "code", "value": str(result)}
+    return [result]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    group = parser.add_mutually_exclusive_group()
+    group.add_argument("--role")
+    group.add_argument("--directive")
+    group.add_argument("--transform")
+    args = parser.parse_args()
+
+    if args.directive:
+        data = json.load(sys.stdin)
+        declare_result(run_directive(args.directive, data))
+    elif args.transform:
+        raise NotImplementedError
+    elif args.role:
+        raise NotImplementedError
+    else:
+        declare_result(plugin)

requirements.txt

@@ -0,0 +1 @@
+pillow