mirror of https://github.com/JoshKarpel/spiel
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.6 KiB
2.6 KiB
Spiel
Spiel is a framework for building and presenting richly-styled presentations in your terminal using Python.
To see what Spiel can do without installing it, you can view the demonstration deck in a container:
$ docker run -it --rm ghcr.io/joshkarpel/spiel
Alternatively, install Spiel (pip install spiel) and run this command to view the demonstration deck:
$ spiel demo present
Quick Start
If you want to jump right in,
install Spiel (pip install spiel),
create a file called deck.py,
and copy this code into it:
from rich.console import RenderableType
from spiel import Deck, present
deck = Deck(name="Your Deck Name")
@deck.slide(title="Slide 1 Title")
def slide_1() -> RenderableType:
return "Your content here!"
if __name__ == "__main__":
present(__file__)
That is the most basic Spiel presentation you can make.
To present the deck, run python deck.py.
You should see:
Check out the Quick Start tutorial to continue!
Documentation
To learn more about Spiel, take a look at the documentation.
Contributing
If you're interested in contributing to Spiel, check out the Contributing Guide.