| Name | jupyter-KULeuven-slides JSON |
| Version |
0.3.5
JSON |
| download |
| home_page | |
| Summary | A minimal and pip-installable jupyter nbconvert template for KULeuven slides. |
| upload_time | 2024-01-29 00:56:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
jupyter
kuleuven
slides
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter KULeuven slides Template
A nbconvert template to convert jupyterlab notebooks into reveal.js slides using the KULeuven presentation style.
# Installation instructions
This nbconvert template can be installed using pip:
```
pip install jupyter-KULeuven-Slides
```
This will make the reveal.js template "KULeuven" available in the python environment.
# Basic usage
First mark (using the ```property inspector``` menu at the left hand side) the start of each slide in any existing Jupyter notebook, by selecting ```slide``` under the topic ```Slide type```.
Subsequently, using the jupyterlab top-menu, please select :```File``` -> ```Save and Export Notebook as``` -> ```KULeuven```
# Command line
Converting Jupyter notebooks into templated KULeuven slides can also be done from the command line as follows:
```
jupyter nbconvert --to KULeuven Notebook.ipynb
```
or converting all notebooks in a folder:
```
jupyter nbconvert --to KULeuven *.ipynb
```
# Adding and modifying the title slide
You can add a title slide, by adding the **notebook metadata** a section labeled ```KULeuvenslides```. In this section the following tags can be optionally added:
```
"KULeuvenSlides": {
"title": "test title",
"subtitle": "test subtitle",
"authors": "Jan Genoe",
"location": "Ergens",
"date": "Vandaag"
},
```
Please do not forget to commit these changes to the jupyter notebook changes after adding this metadata. (The small **v** on top of the box).
The screenshot below shows a possible implementation:
Please do not forget to commit changes after adding metadata. (The small **v** on top of the box).
## Selecting a global template
The following global templates are available:
* Sedes
* Normal
* 1425 (The key referring to the foundation date of our university)
In this folder you can find 3 ```jupyter notebooks``` that are converted according to each of those 3 templates.
The ```Normal``` template is added by adding to the **notebook metadata**
```
"KULeuvenSlides": {
"kuleuven_presentation_style": "Normal"
},
```
Please do not forget to commit changes after adding metadata. (The small **v** on top of the box).
# Adding a structure slide in the presentation, using a different template
A structure slide, typically for the outline of the presentation, can be added at any point in the presentation by adding to the cell metadata under ```KULeuvenSlides```:
```
"KULeuvenSlides": {
"slide_code": "structure"
},
```
(typically there will be already the ```slide_type``` present in this section)
Please do not forget to commit changes after adding metadata. (The small **v** on top of the box).
# Develop notes
For building and developing this [template]( https://github.com/sheeshee/nbconvert-template-example/) has been used.
For the reveal.js template that is used as a source, please [see here](https://github.com/fmoralesc/reveal.js-kuleuven)
See [here](https://nbconvert.readthedocs.io/en/latest/customizing.html) for nbconvert's documentation on creating custom templates.
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyter-KULeuven-slides",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "jupyter,KULeuven,slides",
"author": "",
"author_email": "Jan Genoe <jan.genoe@kuleuven.be>",
"download_url": "https://files.pythonhosted.org/packages/bd/95/d6f75b2f1cac9b64341dc5ae104a2bfe49d8428998456c2f02a2caa902a6/jupyter-KULeuven-slides-0.3.5.tar.gz",
"platform": null,
"description": "# Jupyter KULeuven slides Template\n\nA nbconvert template to convert jupyterlab notebooks into reveal.js slides using the KULeuven presentation style.\n\n# Installation instructions\n\nThis nbconvert template can be installed using pip:\n```\npip install jupyter-KULeuven-Slides\n```\nThis will make the reveal.js template \"KULeuven\" available in the python environment.\n\n\n# Basic usage\n\nFirst mark (using the ```property inspector``` menu at the left hand side) the start of each slide in any existing Jupyter notebook, by selecting ```slide``` under the topic ```Slide type```.\n\n\n\nSubsequently, using the jupyterlab top-menu, please select :```File``` -> ```Save and Export Notebook as``` -> ```KULeuven```\n\n\n\n\n# Command line\n\nConverting Jupyter notebooks into templated KULeuven slides can also be done from the command line as follows:\n\n```\njupyter nbconvert --to KULeuven Notebook.ipynb\n```\n\nor converting all notebooks in a folder:\n\n```\njupyter nbconvert --to KULeuven *.ipynb\n```\n\n# Adding and modifying the title slide\n\nYou can add a title slide, by adding the **notebook metadata** a section labeled ```KULeuvenslides```. In this section the following tags can be optionally added:\n\n```\n\"KULeuvenSlides\": {\n \"title\": \"test title\",\n \"subtitle\": \"test subtitle\",\n \"authors\": \"Jan Genoe\",\n \"location\": \"Ergens\",\n \"date\": \"Vandaag\"\n },\n```\n \n Please do not forget to commit these changes to the jupyter notebook changes after adding this metadata. (The small **v** on top of the box).\nThe screenshot below shows a possible implementation:\n\n\n\nPlease do not forget to commit changes after adding metadata. (The small **v** on top of the box).\n\n## Selecting a global template\n\n\nThe following global templates are available:\n\n* Sedes\n* Normal \n* 1425 (The key referring to the foundation date of our university)\n\nIn this folder you can find 3 ```jupyter notebooks``` that are converted according to each of those 3 templates. \n\nThe ```Normal``` template is added by adding to the **notebook metadata** \n\n```\n\"KULeuvenSlides\": {\n \"kuleuven_presentation_style\": \"Normal\"\n },\n```\n\nPlease do not forget to commit changes after adding metadata. (The small **v** on top of the box).\n\n# Adding a structure slide in the presentation, using a different template\n\nA structure slide, typically for the outline of the presentation, can be added at any point in the presentation by adding to the cell metadata under ```KULeuvenSlides```:\n```\n\"KULeuvenSlides\": {\n \"slide_code\": \"structure\"\n },\n```\n(typically there will be already the ```slide_type``` present in this section)\n\n\nPlease do not forget to commit changes after adding metadata. (The small **v** on top of the box).\n\n# Develop notes\n\nFor building and developing this [template]( https://github.com/sheeshee/nbconvert-template-example/) has been used.\n\nFor the reveal.js template that is used as a source, please [see here](https://github.com/fmoralesc/reveal.js-kuleuven)\n\nSee [here](https://nbconvert.readthedocs.io/en/latest/customizing.html) for nbconvert's documentation on creating custom templates.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A minimal and pip-installable jupyter nbconvert template for KULeuven slides.",
"version": "0.3.5",
"project_urls": null,
"split_keywords": [
"jupyter",
"kuleuven",
"slides"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "990b593b278b03450da395665f7847c83f8929d4f16e4e8f8bc011fbe087182a",
"md5": "39e7297f6f15dc913f33b953bcea15a5",
"sha256": "287501a8f10c79a1f134e54028a9ee6a9708c5d0869a4a0930a97917393777fc"
},
"downloads": -1,
"filename": "jupyter_KULeuven_slides-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39e7297f6f15dc913f33b953bcea15a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 870912,
"upload_time": "2024-01-29T00:56:34",
"upload_time_iso_8601": "2024-01-29T00:56:34.672998Z",
"url": "https://files.pythonhosted.org/packages/99/0b/593b278b03450da395665f7847c83f8929d4f16e4e8f8bc011fbe087182a/jupyter_KULeuven_slides-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd95d6f75b2f1cac9b64341dc5ae104a2bfe49d8428998456c2f02a2caa902a6",
"md5": "61d37d79873b5c443dd53855590a6520",
"sha256": "60cee7c1725ac3eb4f8beb41165aadf7033ceb93cecba0332f90c5e6b15ac7af"
},
"downloads": -1,
"filename": "jupyter-KULeuven-slides-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "61d37d79873b5c443dd53855590a6520",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 871250,
"upload_time": "2024-01-29T00:56:36",
"upload_time_iso_8601": "2024-01-29T00:56:36.833174Z",
"url": "https://files.pythonhosted.org/packages/bd/95/d6f75b2f1cac9b64341dc5ae104a2bfe49d8428998456c2f02a2caa902a6/jupyter-KULeuven-slides-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 00:56:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jupyter-kuleuven-slides"
}
