decktalk 0.1.0__tar.gz → 0.2.0__tar.gz

decktalk-0.2.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: decktalk
+Version: 0.2.0
+Summary: Narrated presentations, cut to the word. A markdown script, an ElevenLabs voice, and HTML slides go in, and one mp4 comes out.
+Keywords: presentation,narration,elevenlabs,video,slides,text-to-speech,markdown,video-generation,explainer-video,lesson,screencast,word-timestamps,playwright,ffmpeg
+Author: Jacob Beaudin
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_NOTICES.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Dist: playwright>=1.50
+Requires-Dist: static-ffmpeg>=2.7
+Requires-Python: >=3.12
+Project-URL: Homepage, https://decktalk.app
+Project-URL: Repository, https://github.com/jacobcbeaudin/decktalk
+Project-URL: Documentation, https://docs.decktalk.app
+Project-URL: Issues, https://github.com/jacobcbeaudin/decktalk/issues
+Project-URL: Changelog, https://github.com/jacobcbeaudin/decktalk/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/hero-dark.svg">
+  <img alt="A playhead moves along a spoken sentence, one tick per word. The slide reacts on exactly the right words." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/hero-light.svg" width="100%">
+</picture>
+
+<h1 align="center">DeckTalk</h1>
+
+<p align="center"><b>Narrated presentations, cut to the word.</b><br>
+DeckTalk makes a narrated video from a markdown script and HTML slides.
+Each reveal starts on the word that introduces it.
+If you change a sentence, DeckTalk voices only that section again.</p>
+
+<p align="center">DeckTalk is for lecturers, course authors, developer advocates, and the agents that help them.</p>
+
+<!-- demo: the video waits for the founder's approval. GitHub strips a <video> tag, so do
+     not paste one.
+     1. Upload the mp4 through GitHub's editor.
+     2. Put the user-attachments URL on its own line in place of the hero picture at the top.
+     3. Move the caption below under that line, and uncomment it.
+     4. Under "Make your first video", change "The scaffold is a five-section lesson" to
+        "The scaffold is the project that made the demo video above".
+<p align="center">DeckTalk built this video from the project that <code>decktalk init</code> writes, in a cloned voice. Turn the sound on, and each reveal starts on its word.</p>
+-->
+
+<p align="center">
+<a href="https://pypi.org/project/decktalk/"><img src="https://img.shields.io/pypi/v/decktalk?style=flat-square&label=pypi&color=2c1fea" alt="PyPI"></a>
+<a href="https://github.com/jacobcbeaudin/decktalk/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/jacobcbeaudin/decktalk/ci.yml?style=flat-square&label=ci" alt="ci"></a>
+<a href="https://github.com/jacobcbeaudin/decktalk/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-black?style=flat-square&labelColor=0a0a0a&color=2c1fea" alt="Apache-2.0"></a>
+</p>
+
+<p align="center">
+<a href="https://docs.decktalk.app/quickstart">Quickstart</a> ·
+<a href="https://docs.decktalk.app">Docs</a> ·
+<a href="https://docs.decktalk.app/requirements">Requirements and costs</a> ·
+<a href="https://docs.decktalk.app/reference/card">Reference card for agents</a> ·
+<a href="https://docs.decktalk.app/changelog">Changelog</a><br>
+Agents can read <a href="https://docs.decktalk.app/llms.txt">llms.txt</a>.
+</p>
+
+## Make your first video
+
+You need Python 3.12 or later. These steps use `uv`, a Python package manager. If you use pipx, run `pipx install decktalk` in step 1 instead.
+
+1. Install DeckTalk.
+
+   ```console
+   uv tool install decktalk
+   ```
+
+   uv ends with `Installed 1 executable: decktalk`.
+
+2. Download Chromium, ffmpeg, and KaTeX. You do this one time per machine.
+
+   ```console
+   decktalk setup
+   ```
+
+   On Linux, this step asks for sudo. The last line is `setup complete`.
+
+3. Create the scaffold, a complete example project.
+
+   ```console
+   decktalk init my-lesson
+   ```
+
+4. Go into the project.
+
+   ```console
+   cd my-lesson
+   ```
+
+5. Build the video without an account.
+
+   ```console
+   decktalk build --silent
+   ```
+
+   The build ends with `built` and the path of `build/out/my-lesson.mp4`. The build took 224.4 seconds on a MacBook Pro with Apple M5 Pro and 64 GB memory, because recording runs in real time.
+
+6. Copy the example settings file.
+
+   ```console
+   cp .env.example .env
+   ```
+
+7. In `.env`, set your ElevenLabs API key and voice id. DeckTalk never prints the key.
+
+8. Build the video with your voice.
+
+   ```console
+   decktalk build
+   ```
+
+   This build spends ElevenLabs credits for every section. It writes the video, SRT and VTT captions, and one chapter per section. [What spends credits](https://docs.decktalk.app/requirements#what-spends-credits) lists the cost.
+
+The scaffold is a five-section lesson. The [quickstart](https://docs.decktalk.app/quickstart) shows the output of each step and [what the example video shows](https://docs.decktalk.app/quickstart#what-the-example-video-shows).
+
+## What you write
+
+<picture>
+  <source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-dark-stacked.svg">
+  <source media="(max-width: 640px)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-light-stacked.svg">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-dark.svg">
+  <img alt="Four panels. Write shows a markdown script. Narrate runs narrate and beats, and shows a tick for every word of &quot;A bowl. A ball. One. Two, three.&quot; with 1.25 over &quot;bowl&quot;. Record runs record, measure, and check, and shows a slide where a bowl draws on and a ball steps down it. Assemble runs assemble and verify, and shows one mp4." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-light.svg" width="100%">
+</picture>
+
+You write four files. One cue id per reveal, such as `1.1bowl`, ties the script, the cues, and the page together.
+
+| File | What it holds |
+|---|---|
+| `script.md` | What the voice says, under one `## N. Title` heading per section. |
+| `decktalk.toml` | The project file. It ties each section to a page or to a clip of your own. |
+| `cues.json` | The phrase that each reveal starts on. |
+| A page in `deck/` | The slides, as plain HTML. |
+
+The `narrate` stage writes a words file with the start and end of every spoken word. If a cue phrase is not in the spoken words, the build stops and names the cue. [Your first deck](https://docs.decktalk.app/guides/first-deck) writes one section in all four files.
+
+## Why the cuts are exact
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/alignment-dark.svg">
+  <img alt="A strip of recorded frames. Three magenta cover frames come first, and a line marks t=0 at the first clean frame. Under the strip, the narration &quot;A bowl. A ball. Watch it step down&quot; starts at t=0. Dashed leads join &quot;bowl&quot; and &quot;ball&quot; to the outlined frames where the bowl and then the ball appear." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/alignment-light.svg" width="100%">
+</picture>
+
+A browser does not start recording at a known time, so DeckTalk does not use a timer. The recorder covers the page in magenta until the narration starts. The first frame without magenta is narration t=0, on Linux, macOS, and Windows.
+
+`decktalk verify` then measures every reveal in the finished video. This sample comes from a silent build of the scaffold.
+
+<!-- sample: decktalk verify 1:1.1bowl 3:3.4name 4:4.1words, silent build of the scaffold (cue table only) -->
+```text
+check                 cue       at   chg %   ctl %   offset     a/v  result
+1:1.1bowl            1.25     1.25    1.05    0.00    -10ms    -9ms  changed
+3:3.4name           71.98   110.58    2.77    0.00    +20ms   +11ms  changed
+4:4.1words          14.31   172.99    1.47    0.00    +10ms   -11ms  changed
+```
+
+The offset column is the time from the cue time to the onset of the reveal, in milliseconds. [Verify](https://docs.decktalk.app/reference/verify) defines every column and limit.
+
+## Requirements and costs
+
+- **Software.** DeckTalk needs Python 3.12 or later, on Linux, macOS, or Windows. `decktalk setup` downloads the rest.
+- **Accounts.** A silent build needs no account. A voiced build needs an ElevenLabs API key and a voice id.
+- **Cost.** Every ElevenLabs plan can call the API. The free plan has limits for a video you publish.
+
+[Requirements and costs](https://docs.decktalk.app/requirements) lists every download and every command that spends credits.
+
+## How it compares
+
+| Tool | Timing comes from | Slides are | After you edit one sentence |
+|---|---|---|---|
+| **DeckTalk** | the spoken words, one time per word | your HTML | DeckTalk voices one section again. `build --only N` records only that section. |
+| Remotion, Motion Canvas | frame numbers or seconds in code, by default | code | You time the change again by hand and render again. |
+| Manim | seconds in code, or bookmarks in the narration with manim-voiceover | code | With manim-voiceover, bookmarks follow the new text. You still render the scene again in Python. |
+| Descript | a recording you made | your screen | Overdub voices the new words. The screen recording does not move with them. |
+| Synthesia, HeyGen | the avatar's speech | their avatar and scenes | You generate the video again. |
+
+The [FAQ](https://docs.decktalk.app/help/faq#how-is-this-different-from-the-other-tools) has the full comparison. Every build also gives you these parts:
+
+- **A free silent build.** Every stage runs with no key, and a click marks each word.
+- **Cached narration.** DeckTalk voices a section again only when it changes.
+- **Captions and chapters.** Every build writes SRT, VTT, and chapters.
+- **A soundscape.** Add [an underscore, an ambience bed, and sound effects](https://docs.decktalk.app/concepts/sound).
+- **Loudness.** DeckTalk normalizes the mix to -16 LUFS.
+- **Checked output.** `check` and `verify` catch bad recordings and late reveals.
+
+## Status and support
+
+DeckTalk is alpha, and a minor release can still break things. One person maintains it.
+
+CI runs the unit tests and a full offline build on Linux for every push to `main` and every pull request. [CONTRIBUTING](https://github.com/jacobcbeaudin/decktalk/blob/main/CONTRIBUTING.md#what-ci-runs) lists the macOS and Windows runs.
+
+- Report bugs and ask questions in [Issues](https://github.com/jacobcbeaudin/decktalk/issues).
+- Report a vulnerability privately. [SECURITY.md](https://github.com/jacobcbeaudin/decktalk/blob/main/SECURITY.md) explains how.
+- The [changelog](https://docs.decktalk.app/changelog) lists every release.
+
+## Documentation
+
+The docs are at **[docs.decktalk.app](https://docs.decktalk.app)**.
+
+- **Install and build a first video:** [Quickstart](https://docs.decktalk.app/quickstart)
+- **Write your own section:** [Your first deck](https://docs.decktalk.app/guides/first-deck)
+- **Give an agent the whole contract:** [Reference card for agents](https://docs.decktalk.app/reference/card)
+
+## Contributing
+
+To work on DeckTalk itself, start with [CONTRIBUTING.md](https://github.com/jacobcbeaudin/decktalk/blob/main/CONTRIBUTING.md).
+
+<p align="center">Apache-2.0. Made by <a href="https://github.com/jacobcbeaudin">Jacob Beaudin</a>.</p>

decktalk-0.2.0/README.md

@@ -0,0 +1,188 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/hero-dark.svg">
+  <img alt="A playhead moves along a spoken sentence, one tick per word. The slide reacts on exactly the right words." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/hero-light.svg" width="100%">
+</picture>
+
+<h1 align="center">DeckTalk</h1>
+
+<p align="center"><b>Narrated presentations, cut to the word.</b><br>
+DeckTalk makes a narrated video from a markdown script and HTML slides.
+Each reveal starts on the word that introduces it.
+If you change a sentence, DeckTalk voices only that section again.</p>
+
+<p align="center">DeckTalk is for lecturers, course authors, developer advocates, and the agents that help them.</p>
+
+<!-- demo: the video waits for the founder's approval. GitHub strips a <video> tag, so do
+     not paste one.
+     1. Upload the mp4 through GitHub's editor.
+     2. Put the user-attachments URL on its own line in place of the hero picture at the top.
+     3. Move the caption below under that line, and uncomment it.
+     4. Under "Make your first video", change "The scaffold is a five-section lesson" to
+        "The scaffold is the project that made the demo video above".
+<p align="center">DeckTalk built this video from the project that <code>decktalk init</code> writes, in a cloned voice. Turn the sound on, and each reveal starts on its word.</p>
+-->
+
+<p align="center">
+<a href="https://pypi.org/project/decktalk/"><img src="https://img.shields.io/pypi/v/decktalk?style=flat-square&label=pypi&color=2c1fea" alt="PyPI"></a>
+<a href="https://github.com/jacobcbeaudin/decktalk/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/jacobcbeaudin/decktalk/ci.yml?style=flat-square&label=ci" alt="ci"></a>
+<a href="https://github.com/jacobcbeaudin/decktalk/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-black?style=flat-square&labelColor=0a0a0a&color=2c1fea" alt="Apache-2.0"></a>
+</p>
+
+<p align="center">
+<a href="https://docs.decktalk.app/quickstart">Quickstart</a> ·
+<a href="https://docs.decktalk.app">Docs</a> ·
+<a href="https://docs.decktalk.app/requirements">Requirements and costs</a> ·
+<a href="https://docs.decktalk.app/reference/card">Reference card for agents</a> ·
+<a href="https://docs.decktalk.app/changelog">Changelog</a><br>
+Agents can read <a href="https://docs.decktalk.app/llms.txt">llms.txt</a>.
+</p>
+
+## Make your first video
+
+You need Python 3.12 or later. These steps use `uv`, a Python package manager. If you use pipx, run `pipx install decktalk` in step 1 instead.
+
+1. Install DeckTalk.
+
+   ```console
+   uv tool install decktalk
+   ```
+
+   uv ends with `Installed 1 executable: decktalk`.
+
+2. Download Chromium, ffmpeg, and KaTeX. You do this one time per machine.
+
+   ```console
+   decktalk setup
+   ```
+
+   On Linux, this step asks for sudo. The last line is `setup complete`.
+
+3. Create the scaffold, a complete example project.
+
+   ```console
+   decktalk init my-lesson
+   ```
+
+4. Go into the project.
+
+   ```console
+   cd my-lesson
+   ```
+
+5. Build the video without an account.
+
+   ```console
+   decktalk build --silent
+   ```
+
+   The build ends with `built` and the path of `build/out/my-lesson.mp4`. The build took 224.4 seconds on a MacBook Pro with Apple M5 Pro and 64 GB memory, because recording runs in real time.
+
+6. Copy the example settings file.
+
+   ```console
+   cp .env.example .env
+   ```
+
+7. In `.env`, set your ElevenLabs API key and voice id. DeckTalk never prints the key.
+
+8. Build the video with your voice.
+
+   ```console
+   decktalk build
+   ```
+
+   This build spends ElevenLabs credits for every section. It writes the video, SRT and VTT captions, and one chapter per section. [What spends credits](https://docs.decktalk.app/requirements#what-spends-credits) lists the cost.
+
+The scaffold is a five-section lesson. The [quickstart](https://docs.decktalk.app/quickstart) shows the output of each step and [what the example video shows](https://docs.decktalk.app/quickstart#what-the-example-video-shows).
+
+## What you write
+
+<picture>
+  <source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-dark-stacked.svg">
+  <source media="(max-width: 640px)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-light-stacked.svg">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-dark.svg">
+  <img alt="Four panels. Write shows a markdown script. Narrate runs narrate and beats, and shows a tick for every word of &quot;A bowl. A ball. One. Two, three.&quot; with 1.25 over &quot;bowl&quot;. Record runs record, measure, and check, and shows a slide where a bowl draws on and a ball steps down it. Assemble runs assemble and verify, and shows one mp4." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/how-it-works-light.svg" width="100%">
+</picture>
+
+You write four files. One cue id per reveal, such as `1.1bowl`, ties the script, the cues, and the page together.
+
+| File | What it holds |
+|---|---|
+| `script.md` | What the voice says, under one `## N. Title` heading per section. |
+| `decktalk.toml` | The project file. It ties each section to a page or to a clip of your own. |
+| `cues.json` | The phrase that each reveal starts on. |
+| A page in `deck/` | The slides, as plain HTML. |
+
+The `narrate` stage writes a words file with the start and end of every spoken word. If a cue phrase is not in the spoken words, the build stops and names the cue. [Your first deck](https://docs.decktalk.app/guides/first-deck) writes one section in all four files.
+
+## Why the cuts are exact
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/alignment-dark.svg">
+  <img alt="A strip of recorded frames. Three magenta cover frames come first, and a line marks t=0 at the first clean frame. Under the strip, the narration &quot;A bowl. A ball. Watch it step down&quot; starts at t=0. Dashed leads join &quot;bowl&quot; and &quot;ball&quot; to the outlined frames where the bowl and then the ball appear." src="https://raw.githubusercontent.com/jacobcbeaudin/decktalk/main/assets/alignment-light.svg" width="100%">
+</picture>
+
+A browser does not start recording at a known time, so DeckTalk does not use a timer. The recorder covers the page in magenta until the narration starts. The first frame without magenta is narration t=0, on Linux, macOS, and Windows.
+
+`decktalk verify` then measures every reveal in the finished video. This sample comes from a silent build of the scaffold.
+
+<!-- sample: decktalk verify 1:1.1bowl 3:3.4name 4:4.1words, silent build of the scaffold (cue table only) -->
+```text
+check                 cue       at   chg %   ctl %   offset     a/v  result
+1:1.1bowl            1.25     1.25    1.05    0.00    -10ms    -9ms  changed
+3:3.4name           71.98   110.58    2.77    0.00    +20ms   +11ms  changed
+4:4.1words          14.31   172.99    1.47    0.00    +10ms   -11ms  changed
+```
+
+The offset column is the time from the cue time to the onset of the reveal, in milliseconds. [Verify](https://docs.decktalk.app/reference/verify) defines every column and limit.
+
+## Requirements and costs
+
+- **Software.** DeckTalk needs Python 3.12 or later, on Linux, macOS, or Windows. `decktalk setup` downloads the rest.
+- **Accounts.** A silent build needs no account. A voiced build needs an ElevenLabs API key and a voice id.
+- **Cost.** Every ElevenLabs plan can call the API. The free plan has limits for a video you publish.
+
+[Requirements and costs](https://docs.decktalk.app/requirements) lists every download and every command that spends credits.
+
+## How it compares
+
+| Tool | Timing comes from | Slides are | After you edit one sentence |
+|---|---|---|---|
+| **DeckTalk** | the spoken words, one time per word | your HTML | DeckTalk voices one section again. `build --only N` records only that section. |
+| Remotion, Motion Canvas | frame numbers or seconds in code, by default | code | You time the change again by hand and render again. |
+| Manim | seconds in code, or bookmarks in the narration with manim-voiceover | code | With manim-voiceover, bookmarks follow the new text. You still render the scene again in Python. |
+| Descript | a recording you made | your screen | Overdub voices the new words. The screen recording does not move with them. |
+| Synthesia, HeyGen | the avatar's speech | their avatar and scenes | You generate the video again. |
+
+The [FAQ](https://docs.decktalk.app/help/faq#how-is-this-different-from-the-other-tools) has the full comparison. Every build also gives you these parts:
+
+- **A free silent build.** Every stage runs with no key, and a click marks each word.
+- **Cached narration.** DeckTalk voices a section again only when it changes.
+- **Captions and chapters.** Every build writes SRT, VTT, and chapters.
+- **A soundscape.** Add [an underscore, an ambience bed, and sound effects](https://docs.decktalk.app/concepts/sound).
+- **Loudness.** DeckTalk normalizes the mix to -16 LUFS.
+- **Checked output.** `check` and `verify` catch bad recordings and late reveals.
+
+## Status and support
+
+DeckTalk is alpha, and a minor release can still break things. One person maintains it.
+
+CI runs the unit tests and a full offline build on Linux for every push to `main` and every pull request. [CONTRIBUTING](https://github.com/jacobcbeaudin/decktalk/blob/main/CONTRIBUTING.md#what-ci-runs) lists the macOS and Windows runs.
+
+- Report bugs and ask questions in [Issues](https://github.com/jacobcbeaudin/decktalk/issues).
+- Report a vulnerability privately. [SECURITY.md](https://github.com/jacobcbeaudin/decktalk/blob/main/SECURITY.md) explains how.
+- The [changelog](https://docs.decktalk.app/changelog) lists every release.
+
+## Documentation
+
+The docs are at **[docs.decktalk.app](https://docs.decktalk.app)**.
+
+- **Install and build a first video:** [Quickstart](https://docs.decktalk.app/quickstart)
+- **Write your own section:** [Your first deck](https://docs.decktalk.app/guides/first-deck)
+- **Give an agent the whole contract:** [Reference card for agents](https://docs.decktalk.app/reference/card)
+
+## Contributing
+
+To work on DeckTalk itself, start with [CONTRIBUTING.md](https://github.com/jacobcbeaudin/decktalk/blob/main/CONTRIBUTING.md).
+
+<p align="center">Apache-2.0. Made by <a href="https://github.com/jacobcbeaudin">Jacob Beaudin</a>.</p>

decktalk-0.2.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,22 @@
+# Third-party notices
+
+DeckTalk is licensed under Apache-2.0 (see LICENSE). This file lists the third-party software that DeckTalk depends on, downloads, or embeds, and the license of each.
+
+| Component | How DeckTalk uses it | License |
+|---|---|---|
+| [Playwright](https://playwright.dev/python/) | Playwright is a Python dependency. It drives headless Chromium to record pages and take screenshots. | Apache-2.0 |
+| Chromium (headless shell) | `decktalk setup` downloads it through Playwright. | BSD-3-Clause and the licenses of its components |
+| [static-ffmpeg](https://github.com/zackees/static_ffmpeg) | static-ffmpeg is a Python dependency. It downloads the ffmpeg and ffprobe binaries into the Python environment, and `decktalk setup` runs that download ahead of time. | BSD-3-Clause |
+| [ffmpeg](https://ffmpeg.org/) source | DeckTalk runs ffmpeg as a separate process to cut, mix, and analyze audio and video. DeckTalk does not link against ffmpeg. | LGPL-2.1-or-later |
+| ffmpeg builds for Linux, Windows, and Intel macOS | static-ffmpeg fetches these builds. They include libx264 and use `--enable-gpl --enable-version3 --enable-libx264`. | GPL-3.0-or-later |
+| ffmpeg build for Apple silicon macOS | static-ffmpeg fetches this build. It includes libx264 and uses `--enable-gpl --enable-libx264`. | GPL-2.0-or-later |
+| [Inter Tight](https://rsms.me/inter/) | The scaffold deck bundles the latin and greek woff2 subsets in `deck/fonts/`, with `InterTight-OFL.txt`. A subset is also embedded in the README graphics under `assets/`. | SIL Open Font License 1.1 |
+| [Inter](https://rsms.me/inter/) | The scaffold deck bundles the latin and greek woff2 subsets in `deck/fonts/`, with `Inter-OFL.txt`. | SIL Open Font License 1.1 |
+| [JetBrains Mono](https://www.jetbrains.com/lp/mono/) | The scaffold deck bundles the latin and greek woff2 subsets in `deck/fonts/`, with `JetBrainsMono-OFL.txt`. | SIL Open Font License 1.1 |
+| [KaTeX](https://katex.org/) | KaTeX typesets equations in the scaffold deck. `decktalk setup` downloads a release into a per-user cache, and `decktalk init` copies it into `deck/katex/`. | MIT |
+| [ElevenLabs](https://elevenlabs.io/) | ElevenLabs is a web API for speech, sound effects, and music. DeckTalk calls it with your own key, under your own account terms. | ElevenLabs terms of service |
+
+Notes:
+
+- DeckTalk uses an ffmpeg on your PATH only when static-ffmpeg cannot give one. To use a build of your own, set `DECKTALK_FFMPEG` and `DECKTALK_FFPROBE`.
+- The wheel does not include KaTeX. If the KaTeX download fails, `decktalk setup` warns and continues. If KaTeX is not cached, `decktalk init` warns, and the pages load KaTeX from a CDN.

{decktalk-0.1.0 → decktalk-0.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "decktalk"
-version = "0.1.0"
-description = "Narrated presentations, cut to the word: a markdown script, an ElevenLabs voice and HTML slides in; one mp4 out."
+version = "0.2.0"
+description = "Narrated presentations, cut to the word. A markdown script, an ElevenLabs voice, and HTML slides go in, and one mp4 comes out."
 readme = "README.md"
 requires-python = ">=3.12"
 license = "Apache-2.0"
@@ -17,6 +17,14 @@ keywords = [
     "video",
     "slides",
     "text-to-speech",
+    "markdown",
+    "video-generation",
+    "explainer-video",
+    "lesson",
+    "screencast",
+    "word-timestamps",
+    "playwright",
+    "ffmpeg",
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -87,5 +95,8 @@ python-version = "3.12"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-markers = ["browser: needs headless Chromium (run `decktalk setup` first)"]
-addopts = "-m 'not browser'"
+markers = [
+    "browser: needs headless Chromium (run `decktalk setup` first)",
+    "media: runs the ffmpeg that `decktalk setup` fetches",
+]
+addopts = "-m 'not browser and not media'"

{decktalk-0.1.0 → decktalk-0.2.0}/pyproject.toml.orig

@@ -1,13 +1,28 @@
 [project]
 name = "decktalk"
-version = "0.1.0"
-description = "Narrated presentations, cut to the word: a markdown script, an ElevenLabs voice and HTML slides in; one mp4 out."
+version = "0.2.0"
+description = "Narrated presentations, cut to the word. A markdown script, an ElevenLabs voice, and HTML slides go in, and one mp4 comes out."
 readme = "README.md"
 requires-python = ">=3.12"
 license = "Apache-2.0"
 license-files = ["LICENSE", "NOTICE", "THIRD_PARTY_NOTICES.md"]
 authors = [{ name = "Jacob Beaudin" }]
-keywords = ["presentation", "narration", "elevenlabs", "video", "slides", "text-to-speech"]
+keywords = [
+    "presentation",
+    "narration",
+    "elevenlabs",
+    "video",
+    "slides",
+    "text-to-speech",
+    "markdown",
+    "video-generation",
+    "explainer-video",
+    "lesson",
+    "screencast",
+    "word-timestamps",
+    "playwright",
+    "ffmpeg",
+]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Console",
@@ -60,5 +75,8 @@ python-version = "3.12"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-markers = ["browser: needs headless Chromium (run `decktalk setup` first)"]
-addopts = "-m 'not browser'"
+markers = [
+    "browser: needs headless Chromium (run `decktalk setup` first)",
+    "media: runs the ffmpeg that `decktalk setup` fetches",
+]
+addopts = "-m 'not browser and not media'"

decktalk-0.2.0/src/decktalk/__init__.py

@@ -0,0 +1,104 @@
+"""DeckTalk: narrated presentation videos, cut to the word.
+
+Public API. The file formats and the page contract are covered by the changelog: a change
+to them bumps the minor version and ships with a migration note. The Python names below may
+still move, and a rename is a breaking change once the project leaves the 0.x series.
+
+    Project, Section types, Settings, load_settings
+    project tables: Voice, Mix, Soundscape, Transition
+    errors: DeckTalkError, ConfigError, MissingInputError, ProviderError, ToolError
+    artifacts: Manifest, Timeline, Beats, Word, Sidecar
+    stages: narrate, resolve_beats, record, measure, check, assemble, verify, shoot,
+            soundscape, build, status
+    results: NarrateResult, BeatsResult, Recording, LeadMeasurement, RecordingCheck,
+             AssembleResult, VerifyResult, SoundscapeItem, BuildResult, StatusReport
+    speech: SpeechProvider, SpeechRequest, register
+
+Everything under decktalk.media, everything under decktalk.providers other than the
+three speech names above, and every name starting with an underscore is internal.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+from .artifacts import Beats, Manifest, Sidecar, Timeline, Word
+from .config import Settings, load_settings
+from .errors import ConfigError, DeckTalkError, MissingInputError, ProviderError, ToolError
+from .project import ClipSection, Mix, PageSection, Project, Section, Soundscape, Transition, Voice
+from .providers.speech import SpeechProvider, SpeechRequest, register
+from .stages import (
+    AssembleResult,
+    BeatsResult,
+    BuildResult,
+    LeadMeasurement,
+    NarrateResult,
+    Recording,
+    RecordingCheck,
+    SoundscapeItem,
+    VerifyResult,
+    assemble,
+    build,
+    check,
+    measure,
+    narrate,
+    record,
+    resolve_beats,
+    shoot,
+    soundscape,
+    verify,
+)
+from .status import StatusReport, status
+
+try:
+    __version__ = version("decktalk")
+except PackageNotFoundError:  # running from a checkout without an install
+    __version__ = "0+unknown"
+
+__all__ = [
+    "AssembleResult",
+    "Beats",
+    "BeatsResult",
+    "BuildResult",
+    "ClipSection",
+    "ConfigError",
+    "DeckTalkError",
+    "LeadMeasurement",
+    "Manifest",
+    "MissingInputError",
+    "Mix",
+    "NarrateResult",
+    "PageSection",
+    "Project",
+    "ProviderError",
+    "Recording",
+    "RecordingCheck",
+    "Section",
+    "Settings",
+    "Sidecar",
+    "Soundscape",
+    "SoundscapeItem",
+    "SpeechProvider",
+    "SpeechRequest",
+    "StatusReport",
+    "Timeline",
+    "ToolError",
+    "Transition",
+    "VerifyResult",
+    "Voice",
+    "Word",
+    "__version__",
+    "assemble",
+    "build",
+    "check",
+    "load_settings",
+    "measure",
+    "narrate",
+    "record",
+    "register",
+    "resolve_beats",
+    "shoot",
+    "soundscape",
+    "status",
+    "verify",
+]