fix: updated the exported readme to include default upload path and i…

…mage-asset-folder attribute
ReadAlongs · Apr 26, 2024 · 8dcbab5 · 8dcbab5
1 parent 2eceb2a
commit 8dcbab5
Show file tree

Hide file tree

Showing 4 changed files with 1,007 additions and 999 deletions.
diff --git a/readalongs/_version.py b/readalongs/_version.py
@@ -1 +1 @@
-__version__ = "1.0.20240404"
+__version__ = "1.0.20240426"
diff --git a/readalongs/align.py b/readalongs/align.py
@@ -685,7 +685,7 @@ def align_audio(
             final_end = aligned_words[-1]["end"]
         if len(aligned_words) != len(word_sequence.words):
             LOGGER.warning(
-                f"Word sequence {i+1} had {len(word_sequence.words)} tokens "
+                f"Word sequence {i + 1} had {len(word_sequence.words)} tokens "
                 f"but produced {len(aligned_words)} segments. "
                 "Check that the anchors are well positioned or "
                 "that the audio corresponds to the text."
@@ -979,7 +979,7 @@ def save_readalong(
     if "images" in config:
         save_images(config=config, output_dir=output_dir)
     save_readme_txt(
-        os.path.join(output_dir, "README.txt"),
+        os.path.join(output_dir, "readme.txt"),
         os.path.basename(ras_path),
         os.path.basename(audio_path),
         config.get("header", "Header goes here"),
@@ -1157,6 +1157,7 @@ def convert_to_xhtml(tokenized_xml, title="Book"):
 RAS_TEMPLATE = """<?xml version='1.0' encoding='utf-8'?>
 <read-along version="1.0">
     <text xml:lang="{{main_lang}}" fallback-langs="{{fallback_langs}}">
+    <!-- DO NOT USE THIS DATA WITHOUT EXPLICIT PERMISSION -->
         <body>
         {{#pages}}
             <div type="page">