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.
1 maintainer
Metadata
1 maintainer
Release files for spiel 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spiel-0.5.1.tar.gz | 62.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spiel-0.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 129.9 kB
Release files / spiel-0.5.1.tar.gz
| Download URL | spiel-0.5.1.tar.gz |
|---|---|
| Size | 62.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e57adcd97d7844fd2293823007d440d54869d8e4e31e7dbf2d3f8b3776423687
|
|
BLAKE2b-256 checksum How to use checksums |
b8f8a5c4817f5b0911140e8fbb6a0ac27e85d11e0513b3d01816c4c73ad63c4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.11.3 Linux/5.15.0-1035-azure
|
Release files / spiel-0.5.1-py3-none-any.whl
| Download URL | spiel-0.5.1-py3-none-any.whl |
|---|---|
| Size | 67.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a7e6398c2e00cedf46ba5c833bf0dd936af809d2fb2d3b6dff29147d9fcfec2e
|
|
BLAKE2b-256 checksum How to use checksums |
531af7da594857ad24b83f948845ba10f0f19ffeb8a4b0d6209fb7b8e05f473e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.11.3 Linux/5.15.0-1035-azure
|
