script to generate opds feed from the latest releases

sample output is in feeds/opds-test.json pending review for validity though it seem to match the existing manually-created one (with some improvements for images and IDs)
daisy · May 21, 2024 · 6b92441 · 6b92441
1 parent 4fa1c54
commit 6b92441
Show file tree

Hide file tree

Showing 6 changed files with 854 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 
 .DS_Store
 .env
-build
+build
+node_modules
+tmp
diff --git a/feeds/opds-test.json b/feeds/opds-test.json
@@ -0,0 +1,217 @@
+{
+  "metadata": {
+    "title": "EPUB Accessibility Test Suite"
+  },
+  "links": [
+    {
+      "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/main/feeds/opds-test.json",
+      "type": "application/opds+json",
+      "rel": "self"
+    }
+  ],
+  "publications": [
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-0301-2.0.0",
+        "title": "Fundamental Accessibility Tests: Basic Functionality",
+        "author": "DAISY Consortium",
+        "description": "These tests include starting the reading system and opening the titles, navigating the content, searching, and using bookmarks and notes.",
+        "collection": "basic-functionality",
+        "modified": "2024-02-05T11:00:00Z",
+        "publisher": "DAISY Consortium",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/fundamental-2.0/Fundamental-Accessibility-Tests-Basic-Functionality-v2.0.0.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/fundamental-2.0/content/epub30-test-0301/EPUB/images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 640,
+          "width": 400
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-0302-2.0.0",
+        "title": "Fundamental Accessibility Tests: Non-Visual Reading",
+        "author": "DAISY Consortium",
+        "description": "These tests are for evaluating the reading experience with an assistive technology tool such as a screen reader or refreshable Braille display. Tests include continuous reading, pause and resume, reading order, alternative text, table and hyperlink navigation, reading MathML, footnote functionality, copying text.",
+        "collection": "non-visual-reading",
+        "modified": "2024-04-20T19:55:00Z",
+        "publisher": "DAISY Consortium",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/fundamental-2.0/Fundamental-Accessibility-Tests-Non-Visual-Reading-v2.0.0.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/fundamental-2.0/content/epub30-test-0302/EPUB/images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 640,
+          "width": 400
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-0304-2.0.0",
+        "title": "Fundamental Accessibility Tests: Read Aloud",
+        "author": "DAISY Consortium",
+        "description": "These tests include start, pause and resume Read Aloud, reading order, punctuation support and visual emphasis of the spoken text.",
+        "collection": "read-aloud",
+        "modified": "2024-01-31T00:00:00Z",
+        "publisher": "DAISY Consortium",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/fundamental-2.0/Fundamental-Accessibility-Tests-Read-Aloud-v2.0.0.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/fundamental-2.0/content/epub30-test-0304/EPUB/images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 640,
+          "width": 400
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-03032.0.0",
+        "title": "Fundamental Accessibility Tests: Visual Adjustments",
+        "author": "DAISY Consortium",
+        "description": "These tests include changing the font and text size, colors, brightness, compatibility with magnification utilities and support for high contrast and SVG images.",
+        "collection": "visual-adjustments",
+        "modified": "2024-02-21T11:00:00Z",
+        "publisher": "DAISY Consortium",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/fundamental-2.0/Fundamental-Accessibility-Tests-Visual-Adjustments-v2.0.0.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/fundamental-2.0/content/epub30-test-0303/EPUB/images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 640,
+          "width": 400
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-0320",
+        "title": "Advanced Accessibility Tests: Media Overlays",
+        "author": "DAISY Consortium",
+        "description": "Accessibility tests for Media Overlays in a reflowable context",
+        "collection": "media-overlays",
+        "modified": "2015-15-08T13:00:00Z",
+        "publisher": "DAISY Consortium",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/media-overlays-1.0/Advanced-Accessibility-Tests-Media-Overlays-v1.0.0.epub"
+        }
+      ],
+      "images": []
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "com.github.epub-testsuite.epub30-test-0340",
+        "title": "Accessibility Tests Extended Descriptions",
+        "author": "DAISY Consortium Transition to EPUB 3 and the DIAGRAM Standards WG",
+        "description": "Tests for accessible extended descriptions of images in EPUBs",
+        "collection": "extended-descriptions",
+        "modified": "2020-09-23T07:00:00Z",
+        "publisher": "DAISY Consortium and DIAGRAM Center",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/math-extdesc-1.1.1/Accessibility-Tests-Extended-Descriptions-v1.1.1.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/math-extdesc-1.1.1/content/epub30-test-0350/EPUB/Images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 559,
+          "width": 398
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "@type": "http://schema.org/Book",
+        "identifier": "daisy.diagram.mathMLRecommendation",
+        "title": "Accessibility Tests Mathematics",
+        "author": "DAISY Consortium Transition to EPUB 3 and the DIAGRAM Center Standards WG",
+        "description": "Math Recommendation for EPUB",
+        "collection": "math",
+        "modified": "2020-09-23T07:00:00Z",
+        "publisher": "DAISY Consortium and the DIAGRAM Center",
+        "subject": [
+          "epubtest.org en"
+        ]
+      },
+      "links": [
+        {
+          "type": "application/epub+zip",
+          "rel": "http://opds-spec.org/acquisition/open-access",
+          "href": "https://github.com/daisy/epub-accessibility-tests/releases/download/math-extdesc-1.1.1/Accessibility-Tests-Mathematics-v1.1.1.epub"
+        }
+      ],
+      "images": [
+        {
+          "href": "https://raw.githubusercontent.com/daisy/epub-accessibility-tests/math-extdesc-1.1.1/content/epub30-test-0360/EPUB/Images/cover.jpg",
+          "type": "image/jpeg",
+          "height": 534,
+          "width": 398
+        }
+      ]
+    }
+  ]
+}
diff --git a/feeds/src/example.env b/feeds/src/example.env
@@ -0,0 +1,9 @@
+DOWNLOAD = true
+TMP = '/tmp'
+ORG = "daisy"
+REPO = "epub-accessibility-tests"
+DEFAULT_PUBLISHER = "DAISY Consortium"
+SUBJECT = "epubtest.org"
+AUTH_TOKEN = 'SECRET_GITHUB_TOKEN'
+TITLE = 'EPUB Accessibility Test Suite'
+OPDS_LINK = 'https://raw.githubusercontent.com/daisy/epub-accessibility-tests/main/feeds/opds.json'