# Spiel
[](https://pypi.org/project/spiel)
[](https://pypi.org/project/spiel)
[](https://www.spiel.how)
[](https://results.pre-commit.ci/latest/github/JoshKarpel/spiel/main)
[](https://codecov.io/gh/JoshKarpel/spiel)
[](https://github.com/psf/black)
[](https://github.com/JoshKarpel/spiel/issues)
[](https://github.com/JoshKarpel/spiel/pulls)
[Spiel](https://dictionary.cambridge.org/us/dictionary/english/spiel) is a framework for building and presenting
[richly-styled](https://github.com/Textualize/rich) presentations in your terminal using Python.
To see what Spiel can do without installing it, you can view the demonstration deck in a container:
```bash
$ docker run -it --rm ghcr.io/joshkarpel/spiel
```
Alternatively, install Spiel (`pip install spiel`) and run this command to view the demonstration deck:
```bash
$ 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:
```python
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](https://www.spiel.how/quickstart) to continue!
## Documentation
To learn more about Spiel, take a look at the [documentation](https://www.spiel.how).
## Contributing
If you're interested in contributing to Spiel, check out the [Contributing Guide](https://www.spiel.how/contributing/).
Raw data
{
"_id": null,
"home_page": "https://github.com/JoshKarpel/spiel",
"name": "spiel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4",
"maintainer_email": "",
"keywords": "presentation,slides,tui,terminal",
"author": "JoshKarpel",
"author_email": "josh.karpel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b8/f8/a5c4817f5b0911140e8fbb6a0ac27e85d11e0513b3d01816c4c73ad63c4c/spiel-0.5.1.tar.gz",
"platform": null,
"description": "# Spiel\n\n[](https://pypi.org/project/spiel)\n[](https://pypi.org/project/spiel)\n[](https://www.spiel.how)\n\n[](https://results.pre-commit.ci/latest/github/JoshKarpel/spiel/main)\n[](https://codecov.io/gh/JoshKarpel/spiel)\n[](https://github.com/psf/black)\n\n[](https://github.com/JoshKarpel/spiel/issues)\n[](https://github.com/JoshKarpel/spiel/pulls)\n\n[Spiel](https://dictionary.cambridge.org/us/dictionary/english/spiel) is a framework for building and presenting\n[richly-styled](https://github.com/Textualize/rich) presentations in your terminal using Python.\n\nTo see what Spiel can do without installing it, you can view the demonstration deck in a container:\n```bash\n$ docker run -it --rm ghcr.io/joshkarpel/spiel\n```\nAlternatively, install Spiel (`pip install spiel`) and run this command to view the demonstration deck:\n```bash\n$ spiel demo present\n```\n\n\n\n\n## Quick Start\n\nIf you want to jump right in,\ninstall Spiel (`pip install spiel`),\ncreate a file called `deck.py`,\nand copy this code into it:\n```python\nfrom rich.console import RenderableType\n\nfrom spiel import Deck, present\n\ndeck = Deck(name=\"Your Deck Name\")\n\n\n@deck.slide(title=\"Slide 1 Title\")\ndef slide_1() -> RenderableType:\n return \"Your content here!\"\n\n\nif __name__ == \"__main__\":\n present(__file__)\n```\n\nThat is the most basic Spiel presentation you can make.\nTo present the deck, run `python deck.py`.\nYou should see:\n\n\n\nCheck out the [Quick Start tutorial](https://www.spiel.how/quickstart) to continue!\n\n## Documentation\n\nTo learn more about Spiel, take a look at the [documentation](https://www.spiel.how).\n\n## Contributing\n\nIf you're interested in contributing to Spiel, check out the [Contributing Guide](https://www.spiel.how/contributing/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A framework for building and presenting richly-styled presentations in your terminal using Python.",
"version": "0.5.1",
"split_keywords": [
"presentation",
"slides",
"tui",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "531af7da594857ad24b83f948845ba10f0f19ffeb8a4b0d6209fb7b8e05f473e",
"md5": "15128c624e6869a4d53674d9b52683e5",
"sha256": "a7e6398c2e00cedf46ba5c833bf0dd936af809d2fb2d3b6dff29147d9fcfec2e"
},
"downloads": -1,
"filename": "spiel-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15128c624e6869a4d53674d9b52683e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4",
"size": 67474,
"upload_time": "2023-04-21T23:53:31",
"upload_time_iso_8601": "2023-04-21T23:53:31.018706Z",
"url": "https://files.pythonhosted.org/packages/53/1a/f7da594857ad24b83f948845ba10f0f19ffeb8a4b0d6209fb7b8e05f473e/spiel-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8f8a5c4817f5b0911140e8fbb6a0ac27e85d11e0513b3d01816c4c73ad63c4c",
"md5": "58d9cf1ad0e72c475a2c1c74f36b4803",
"sha256": "e57adcd97d7844fd2293823007d440d54869d8e4e31e7dbf2d3f8b3776423687"
},
"downloads": -1,
"filename": "spiel-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "58d9cf1ad0e72c475a2c1c74f36b4803",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4",
"size": 62453,
"upload_time": "2023-04-21T23:53:32",
"upload_time_iso_8601": "2023-04-21T23:53:32.645766Z",
"url": "https://files.pythonhosted.org/packages/b8/f8/a5c4817f5b0911140e8fbb6a0ac27e85d11e0513b3d01816c4c73ad63c4c/spiel-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-21 23:53:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "JoshKarpel",
"github_project": "spiel",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "spiel"
}
JSON
