| Name | presentpy JSON |
| Version |
1.4.5
JSON |
| download |
| home_page | None |
| Summary | Create slides from Jupyter Notebooks |
| upload_time | 2024-08-21 18:29:28 |
| maintainer | None |
| docs_url | None |
| author | Antonio Feregrino |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
PresentPy
=========
> Create slides from Jupyter Notebooks
_PresentPy_ allows you to take your Jupyter Notebooks and turn them into slides (compatible with PowerPoint, Keynote, LibreOffice...) that then can be integrated into your presentation decks.
## Installation
I strongly recommend using `pipx` to install _PresentPy_:
```bash
pipx install presentpy
```
Otherwise, you can install it using `pip` or your favorite package manager – the package is called `presentpy`.
## Usage
To turn a notebook into slides, simply run:
```bash
Usage: presentpy [OPTIONS] NOTEBOOK
A CLI tool to convert Jupyter Notebooks to slides.
Options:
--output PATH Directory or file path where the output ODP file will be
saved. Defaults to the current directory.
--theme TEXT Pygments style to be applied to the presentation.Defaults to
'default'. See https://pygments.org/docs/styles/ for
available styles.
--outputs Include code cell outputs in the presentation.
--help Show this message and exit.
```
<!--
It also works with Python scripts:
```bash
presentpy [OPTIONS] py SCRIPT_PATH
```
-->
## Code configuration
You can configure the code cells to be displayed in the slides by adding a comment on the last line of the cell. The comment should start with `#%` and then you can add the following options:
- `title`: The title of the slide
- `highlights`: A comma separated list of lines to highlight, each highlight could be a number or a range of lines separated by a dash, e.g. `1,3-6,6-7`
## Example
Consider the notebook shown below, when converted to slides using the `default` theme, it will look like the first image in the table below. When converted using the `fruity` theme, it will look like the second image.
<table>
<tbody>
<tr>
<th colspan="2">Original notebook [<a href="tests/files/test.ipynb" target="_blank">view .ipynb</a>]</th>
</tr>
<tr>
<td colspan="2">
<img src="docs/images/demo-notebook.png" />
</td>
</tr>
<tr>
<th>Default theme
[<a href="https://drive.google.com/file/d/1HuYzFU8rTMa21dC0r7hD9gFByJJ3Cd4f/view?usp=sharing" target="_blank">as PDF</a>]
[<a href="https://docs.google.com/presentation/d/1ZuRIwh6Eq11AAp6JtsMZw9yhbDB2yZAzAFEDrw3bvF4/edit?usp=sharing">as Google Slides</a>]
</th>
<th>Fruity theme
[<a href="https://drive.google.com/file/d/1a5FwVKyBWUS7iGJZoFlO_vnd_czbMZBe/view?usp=drive_link" target="_blank">as PDF</a>]
[<a href="https://docs.google.com/presentation/d/1ObZPZx9lEE_UuqjXcfrRuwPq2dmQTahiO7yq1Zqjwc8/edit?usp=sharing">as Google Slides</a>]
</th>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide1.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide1.jpeg" />
</td>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide2.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide2.jpeg" />
</td>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide3.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide3.jpeg" />
</td>
</tr>
<tr>
<td colspan="2">
Slides omitted as the only change is the highlighting of the code.
</td>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide7.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide7.jpeg" />
</td>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide8.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide8.jpeg" />
</td>
</tr>
<tr>
<td>
<img src="docs/images/demo-default/Slide9.jpeg" />
</td>
<td>
<img src="docs/images/demo-fruity/Slide9.jpeg" />
</td>
</tr>
</tbody>
</table>
You can then use these slides in your presentation deck.
Raw data
{
"_id": null,
"home_page": null,
"name": "presentpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Antonio Feregrino",
"author_email": "antonio.feregrino@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/85/91/98986b931b74e71bd1194fb85ba7ba73213dc461b84216fb86f7763bea71/presentpy-1.4.5.tar.gz",
"platform": null,
"description": "PresentPy\n=========\n\n > Create slides from Jupyter Notebooks\n\n_PresentPy_ allows you to take your Jupyter Notebooks and turn them into slides (compatible with PowerPoint, Keynote, LibreOffice...) that then can be integrated into your presentation decks.\n\n## Installation\n\nI strongly recommend using `pipx` to install _PresentPy_:\n\n```bash\npipx install presentpy\n```\n\nOtherwise, you can install it using `pip` or your favorite package manager \u2013 the package is called `presentpy`.\n\n## Usage\n\nTo turn a notebook into slides, simply run:\n\n```bash\nUsage: presentpy [OPTIONS] NOTEBOOK\n\n A CLI tool to convert Jupyter Notebooks to slides.\n\nOptions:\n --output PATH Directory or file path where the output ODP file will be\n saved. Defaults to the current directory.\n --theme TEXT Pygments style to be applied to the presentation.Defaults to\n 'default'. See https://pygments.org/docs/styles/ for\n available styles.\n --outputs Include code cell outputs in the presentation.\n --help Show this message and exit.\n```\n\n<!-- \nIt also works with Python scripts:\n\n```bash\npresentpy [OPTIONS] py SCRIPT_PATH\n```\n-->\n\n## Code configuration\n\nYou can configure the code cells to be displayed in the slides by adding a comment on the last line of the cell. The comment should start with `#%` and then you can add the following options:\n\n - `title`: The title of the slide\n - `highlights`: A comma separated list of lines to highlight, each highlight could be a number or a range of lines separated by a dash, e.g. `1,3-6,6-7`\n\n## Example\n\nConsider the notebook shown below, when converted to slides using the `default` theme, it will look like the first image in the table below. When converted using the `fruity` theme, it will look like the second image.\n\n<table>\n\t<tbody>\n <tr>\n\t\t\t<th colspan=\"2\">Original notebook [<a href=\"tests/files/test.ipynb\" target=\"_blank\">view .ipynb</a>]</th>\n </tr>\n <tr>\n\t\t\t<td colspan=\"2\">\n <img src=\"docs/images/demo-notebook.png\" />\n </td>\n </tr>\n\t\t<tr>\n\t\t\t<th>Default theme \n [<a href=\"https://drive.google.com/file/d/1HuYzFU8rTMa21dC0r7hD9gFByJJ3Cd4f/view?usp=sharing\" target=\"_blank\">as PDF</a>]\n [<a href=\"https://docs.google.com/presentation/d/1ZuRIwh6Eq11AAp6JtsMZw9yhbDB2yZAzAFEDrw3bvF4/edit?usp=sharing\">as Google Slides</a>]\n </th>\n\t\t\t<th>Fruity theme \n [<a href=\"https://drive.google.com/file/d/1a5FwVKyBWUS7iGJZoFlO_vnd_czbMZBe/view?usp=drive_link\" target=\"_blank\">as PDF</a>]\n [<a href=\"https://docs.google.com/presentation/d/1ObZPZx9lEE_UuqjXcfrRuwPq2dmQTahiO7yq1Zqjwc8/edit?usp=sharing\">as Google Slides</a>]\n </th>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide1.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide1.jpeg\" />\n </td>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide2.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide2.jpeg\" />\n </td>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide3.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide3.jpeg\" />\n </td>\n\t\t</tr>\n\t\t<tr>\n <td colspan=\"2\">\n Slides omitted as the only change is the highlighting of the code.\n </td>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide7.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide7.jpeg\" />\n </td>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide8.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide8.jpeg\" />\n </td>\n\t\t</tr>\n\t\t<tr>\n <td>\n <img src=\"docs/images/demo-default/Slide9.jpeg\" />\n </td>\n\t\t\t<td>\n <img src=\"docs/images/demo-fruity/Slide9.jpeg\" />\n </td>\n\t\t</tr>\n\t</tbody>\n</table>\n\nYou can then use these slides in your presentation deck.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Create slides from Jupyter Notebooks",
"version": "1.4.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d546aae83c0aefdd71437b3d583e63f69cb5da5462bc5cc6e7dd7389c14fb3f",
"md5": "7d6b680eaf8dc38296766fca3ca1be82",
"sha256": "9e1317d5f868077d7aad021a0f5caec638fba57d5b1663a7ec31e06c90e6857d"
},
"downloads": -1,
"filename": "presentpy-1.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d6b680eaf8dc38296766fca3ca1be82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 25425,
"upload_time": "2024-08-21T18:29:27",
"upload_time_iso_8601": "2024-08-21T18:29:27.040242Z",
"url": "https://files.pythonhosted.org/packages/6d/54/6aae83c0aefdd71437b3d583e63f69cb5da5462bc5cc6e7dd7389c14fb3f/presentpy-1.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "859198986b931b74e71bd1194fb85ba7ba73213dc461b84216fb86f7763bea71",
"md5": "82b9e4c77bd15ae5d25c04335075c87f",
"sha256": "bab7c878b917fec734d93aeeeec09c4fed633259ebb21faa3ae6ab63552fcbde"
},
"downloads": -1,
"filename": "presentpy-1.4.5.tar.gz",
"has_sig": false,
"md5_digest": "82b9e4c77bd15ae5d25c04335075c87f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 35054,
"upload_time": "2024-08-21T18:29:28",
"upload_time_iso_8601": "2024-08-21T18:29:28.445313Z",
"url": "https://files.pythonhosted.org/packages/85/91/98986b931b74e71bd1194fb85ba7ba73213dc461b84216fb86f7763bea71/presentpy-1.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 18:29:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "presentpy"
}
