termdeck 0.1.0__tar.gz

termdeck-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 termdeck contributors
+
+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.

termdeck-0.1.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: termdeck
+Version: 0.1.0
+Summary: Terminal presentations, written in Markdown or Python
+License: MIT
+Keywords: presentation,slides,terminal,textual,markdown
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Graphics :: Presentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=0.84
+Provides-Extra: music
+Requires-Dist: musicpy; extra == "music"
+Requires-Dist: pygame; extra == "music"
+Requires-Dist: mido-fix; extra == "music"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# TermDeck
+
+Terminal presentations, written in Markdown or Python. Built on [Textual](https://github.com/Textualize/textual).
+
+Each file in a deck folder is one slide. Navigate with the arrow keys.
+
+## Install
+
+```bash
+pip install termdeck
+```
+
+Optional extras:
+
+```bash
+pip install "termdeck[music]"   # interactive music-pad slides
+```
+
+## Usage
+
+```bash
+termdeck                # play the bundled sample deck
+termdeck ./my-deck      # play your own deck
+python -m termdeck      # same thing
+```
+
+Navigate with **← / →** arrow keys; quit with **Ctrl+C**.
+
+## Writing a deck
+
+A deck is a folder of slide files. Files are sorted by name.
+
+### Markdown slides
+
+```markdown
+# My title
+
+- a bullet
+- another bullet
+```
+
+### Python slides
+
+A Python slide is a [Textual `Screen`](https://textual.textualize.io/api/screen/). It must expose a `Slide` class:
+
+```python
+from textual.app import ComposeResult
+from textual.screen import Screen
+from textual.widgets import Button
+
+class Slide(Screen):
+    def compose(self) -> ComposeResult:
+        yield Button("Hello")
+```
+
+The screen's widgets are styled by `styles/default.tcss`, which you can override in
+your deck if you want. All Textual functionality is available for rich,
+interactive slides.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python test.py
+python -m build
+```
+
+## License
+
+MIT

termdeck-0.1.0/README.md

@@ -0,0 +1,70 @@
+# TermDeck
+
+Terminal presentations, written in Markdown or Python. Built on [Textual](https://github.com/Textualize/textual).
+
+Each file in a deck folder is one slide. Navigate with the arrow keys.
+
+## Install
+
+```bash
+pip install termdeck
+```
+
+Optional extras:
+
+```bash
+pip install "termdeck[music]"   # interactive music-pad slides
+```
+
+## Usage
+
+```bash
+termdeck                # play the bundled sample deck
+termdeck ./my-deck      # play your own deck
+python -m termdeck      # same thing
+```
+
+Navigate with **← / →** arrow keys; quit with **Ctrl+C**.
+
+## Writing a deck
+
+A deck is a folder of slide files. Files are sorted by name.
+
+### Markdown slides
+
+```markdown
+# My title
+
+- a bullet
+- another bullet
+```
+
+### Python slides
+
+A Python slide is a [Textual `Screen`](https://textual.textualize.io/api/screen/). It must expose a `Slide` class:
+
+```python
+from textual.app import ComposeResult
+from textual.screen import Screen
+from textual.widgets import Button
+
+class Slide(Screen):
+    def compose(self) -> ComposeResult:
+        yield Button("Hello")
+```
+
+The screen's widgets are styled by `styles/default.tcss`, which you can override in
+your deck if you want. All Textual functionality is available for rich,
+interactive slides.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python test.py
+python -m build
+```
+
+## License
+
+MIT

termdeck-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "termdeck"
+dynamic = ["version"]
+description = "Terminal presentations, written in Markdown or Python"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+keywords = ["presentation", "slides", "terminal", "textual", "markdown"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Multimedia :: Graphics :: Presentation",
+]
+dependencies = [
+    "textual>=0.84",
+]
+
+[project.optional-dependencies]
+music = ["musicpy", "pygame", "mido-fix"]
+dev = ["build", "twine"]
+
+[project.scripts]
+termdeck = "termdeck.deck:main"
+
+[tool.setuptools]
+packages = ["termdeck"]
+
+[tool.setuptools.dynamic]
+version = { attr = "termdeck.__version__" }
+
+[tool.setuptools.package-data]
+termdeck = ["styles/*.tcss", "sample/*"]

termdeck-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

termdeck-0.1.0/termdeck/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

termdeck-0.1.0/termdeck/__main__.py

@@ -0,0 +1,3 @@
+from termdeck.deck import main
+
+main()

termdeck-0.1.0/termdeck/app.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+
+from textual import events
+from textual.app import App
+from textual.widgets import Footer, Header
+
+from termdeck.deck import load_deck
+
+
+class TermDeck(App):
+    """A terminal presentation app: arrow keys walk through a deck of slides."""
+
+    title = "TermDeck"
+    CSS_PATH = str(Path(__file__).parent / "styles" / "default.tcss")
+
+    def __init__(self, deck_dir: Path, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.slide_number = 0
+        self.names = [name for name, _ in load_deck(deck_dir)]
+        for name, cls in load_deck(deck_dir):
+            self.install_screen(cls, name)
+
+    def on_key(self, event: events.Key) -> None:
+        names = self.names
+        if not names:
+            return
+
+        if event.key == "right" and self.slide_number < len(names) - 1:
+            self.slide_number += 1
+        elif event.key == "left" and self.slide_number > 0:
+            self.slide_number -= 1
+        else:
+            return
+
+        self.push_screen(names[self.slide_number])
+
+    def compose(self):
+        yield Header()
+        yield Footer()
+
+
+if __name__ == "__main__":
+    TermDeck(Path("slides")).run()

termdeck-0.1.0/termdeck/deck.py

@@ -0,0 +1,67 @@
+import importlib.util
+import sys
+from pathlib import Path
+
+from textual.screen import Screen
+from textual.widgets import Markdown
+
+SLIDE_EXTS = (".md", ".MD", ".py")
+
+
+def load_slide(path: Path) -> type[Screen]:
+    """Load a single slide file (markdown or python Textual screen) as a Screen."""
+    path = Path(path)
+    if path.suffix in (".md", ".MD"):
+        return _markdown_slide(path.read_text())
+    if path.suffix == ".py":
+        return _python_slide(path)
+    raise ValueError(f"Unsupported slide type: {path.suffix}")
+
+
+def load_deck(directory: Path) -> list[tuple[str, type[Screen]]]:
+    """Load all slides in a directory, sorted by filename."""
+    slides = []
+    for path in sorted(Path(directory).iterdir()):
+        if path.name == "__init__.py":
+            continue
+        if path.suffix not in SLIDE_EXTS:
+            continue
+        slides.append((path.name, load_slide(path)))
+    return slides
+
+
+def _markdown_slide(content: str) -> type[Screen]:
+    class Slide(Screen):
+        def compose(self):
+            yield Markdown(content, id="markdown")
+
+    return Slide
+
+
+def _python_slide(path: Path) -> type[Screen]:
+    spec = importlib.util.spec_from_file_location(f"termdeck_slide_{path.stem}", path)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module.Slide
+
+
+def main() -> None:
+    if len(sys.argv) > 1:
+        deck_dir = Path(sys.argv[1])
+    else:
+        deck_dir = Path(__file__).parent / "sample"
+
+    if not deck_dir.is_dir():
+        sys.exit(f"error: not a directory: {deck_dir}")
+
+    slides = load_deck(deck_dir)
+    if not slides:
+        sys.exit(f"error: no slides (.md/.py) found in {deck_dir}")
+
+    from termdeck.app import TermDeck
+
+    TermDeck(deck_dir).run()
+
+
+if __name__ == "__main__":
+    main()

termdeck-0.1.0/termdeck/sample/p01_intro.md

@@ -0,0 +1,5 @@
+# TermDeck
+
+Terminal presentations, written in Markdown or Python.
+
+Navigate with the arrow keys.

termdeck-0.1.0/termdeck/sample/p02_slides.md

@@ -0,0 +1,6 @@
+# Writing slides
+
+Each file in your deck directory is one slide.
+
+- `something.md` renders as Markdown
+- `something.py` defines a Textual screen (must expose a `Slide` class)

termdeck-0.1.0/termdeck/styles/default.tcss

@@ -0,0 +1,3 @@
+#markdown {
+    margin: 0 20;
+}

termdeck-0.1.0/termdeck.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: termdeck
+Version: 0.1.0
+Summary: Terminal presentations, written in Markdown or Python
+License: MIT
+Keywords: presentation,slides,terminal,textual,markdown
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Graphics :: Presentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=0.84
+Provides-Extra: music
+Requires-Dist: musicpy; extra == "music"
+Requires-Dist: pygame; extra == "music"
+Requires-Dist: mido-fix; extra == "music"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# TermDeck
+
+Terminal presentations, written in Markdown or Python. Built on [Textual](https://github.com/Textualize/textual).
+
+Each file in a deck folder is one slide. Navigate with the arrow keys.
+
+## Install
+
+```bash
+pip install termdeck
+```
+
+Optional extras:
+
+```bash
+pip install "termdeck[music]"   # interactive music-pad slides
+```
+
+## Usage
+
+```bash
+termdeck                # play the bundled sample deck
+termdeck ./my-deck      # play your own deck
+python -m termdeck      # same thing
+```
+
+Navigate with **← / →** arrow keys; quit with **Ctrl+C**.
+
+## Writing a deck
+
+A deck is a folder of slide files. Files are sorted by name.
+
+### Markdown slides
+
+```markdown
+# My title
+
+- a bullet
+- another bullet
+```
+
+### Python slides
+
+A Python slide is a [Textual `Screen`](https://textual.textualize.io/api/screen/). It must expose a `Slide` class:
+
+```python
+from textual.app import ComposeResult
+from textual.screen import Screen
+from textual.widgets import Button
+
+class Slide(Screen):
+    def compose(self) -> ComposeResult:
+        yield Button("Hello")
+```
+
+The screen's widgets are styled by `styles/default.tcss`, which you can override in
+your deck if you want. All Textual functionality is available for rich,
+interactive slides.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python test.py
+python -m build
+```
+
+## License
+
+MIT

termdeck-0.1.0/termdeck.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+termdeck/__init__.py
+termdeck/__main__.py
+termdeck/app.py
+termdeck/deck.py
+termdeck.egg-info/PKG-INFO
+termdeck.egg-info/SOURCES.txt
+termdeck.egg-info/dependency_links.txt
+termdeck.egg-info/entry_points.txt
+termdeck.egg-info/requires.txt
+termdeck.egg-info/top_level.txt
+termdeck/sample/p01_intro.md
+termdeck/sample/p02_slides.md
+termdeck/styles/default.tcss

termdeck-0.1.0/termdeck.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

termdeck-0.1.0/termdeck.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+termdeck = termdeck.deck:main

termdeck-0.1.0/termdeck.egg-info/requires.txt

@@ -0,0 +1,10 @@
+textual>=0.84
+
+[dev]
+build
+twine
+
+[music]
+musicpy
+pygame
+mido-fix

termdeck-0.1.0/termdeck.egg-info/top_level.txt

@@ -0,0 +1 @@
+termdeck