| Name | PyGlide JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | `PyGlide` (Python Guided Learning through Interactive Digital Education) is a python package for generating live notebooks where you can learn the content by listening to and reading from the slides at the same time you can write and execute yourown code from the slides in real time. |
| upload_time | 2023-08-22 03:45:08 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | Copyright (c) 2023 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
code
live
notebook
py-scripts
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LISPI Documentation
## Introduction
`lispi` (Learning Interactive Slides and PIthon) is a Python package that provides a convenient way to convert Jupyter notebooks into interactive slides. It allows users to create engaging presentations with interactive elements directly from the slides.
## Installation
### Install from GitHub files
To install `lispi` package, you can clone the repository from GitHub and modify it to your liking and install on your system. Open your terminal and run the following command:
```
git clone https://github.com/B7M/lispi.git
```
Navigate to the directory containing the repository and follow these steps:
Make the build file:
```
python -m build
```
Once the build file is created successfully, you will see a folder named `dist` in the directory which contains `.whl` and '.tar.gz'. The name of the file will be the {package name}-{version number}-{py3-none-any.whl}. At this point run `pip install dist/{the .whl file}` command to install the package, here is an example of installing the package with `version 0.0.10`:
```
pip install dist/lispi-0.0.10-py3-none-any.whl
```
### Install from PyPI
To install `lispi` package, you can use pip, the Python package installer. Open your terminal and run the following command:
```
pip install lispi
```
## Configuration
Lispi provides several configuration options to customize the output slides. You can pass these options as arguments when creating an instance of the `lispi` class or running lispi from command line. Here are the available configuration options:
- `audio`: Specify if you wish the output without audio (default: "un-mute"). If you wish to generate the output without audio, you can pass "-m" as the value for this argument.
- `AI_assistant`: Specify if the output file should include an AI assistant (default: "AI prompt is included"). If you wish to generate the output without AI assistant, you can pass "-p" as the value for this argument.
Example:
```bash
lispi original_example -m -p
```
```python
generator = lispi(
audio="False",
aI_assistant="False"
)
```
## Usage
Preparation:
- Open a Jupyter notebook in Jupyter Lab or Jupyter Notebook.
- Add a markdown cell at the top of the notebook.
- Use level 1 heading to specify the title of the presentation and level 2 heading to specify the author and additional information.
- Make sure each cell is labeled with the write Slide Type (e.g. Slide, Sub-Slide, Fragment, Skip, Notes, etc.). This step is very important as it will determine the slides and the audio files that will be generated.
- While preparing the slides you may wish to receive input from the user. Lispi allows you to receive input from the user as simple text or as executable code.
To do so, you should use `<div><!--Course_Text--></div>` in any slides you want to receive simple text. This HTML line will not be visible in the output slides. It will be server as a target for lispi. Similarly, to receive executable code, you can use `<div><!--Course_Code--></div>` in any slides you want to receive executable code. The package will automatically convert the input cells into interactive cells in the output slides.
We included an example notebook in the package to show you how to prepare your notebook for lispi. To access the example notebook after installing lispi `pip install lispi` in command line execute the following line `lispi original_example` this will generate a folder `output` which will contain the example notebook file. You can use this notebook to see how you can prepare your notebook for lispi. You can also use this notebook to test the package.
### Command Line Interface
To use lispi, in your terminal follow these steps:
After installing the package, you can use the `lispi` command to convert your Jupyter notebook into interactive slides. In your terminal, navigate to the folder containing the notebooks and run the following command:
```lispi```
Upon running the command, the package will prompt you with help text to show you how you can use it. Enter the name of the file press enter. The package will convert the Jupyter notebook into interactive slides and save the output HTML file in the output folder in the same directory as html file and audio file folder. If you wish to convert the notebook named `original_example.ipynb`, you will enter `original_example` and press enter. If you wish to convert the notebook without audio, you can enter `lispi -m original_example` and press enter.
### Python
If you want to use lispi in your Python code, you can import the package and use it as a library. To use lispi, in python follow these steps:
1. Import the `Gen` class from the package:
```python
import lispi
```
or
```python
from lispi import *
```
2. Create an instance of the `Interactive Slides Generator` class:
```python
generator = lispi.Gen
```
3. Specify the Jupyter notebook file you want to convert:
```python
notebook_file = "path/to/your/notebook.ipynb"
```
4. Generate the interactive slides:
```python
generator(notebook_file)
```
5. The package will convert the Jupyter notebook into interactive slides and save the output HTML file in the output folder in the same directory as html file and audio file folder.
## Examples
Here is an example that comes with the package. To run the example, in your terminal or python code provide 'original_example' as the file name.
(with audio and AI assistant)
```bash
lispi original_example -p
```
or
```bash
lispi -i original_example -p
```
(without audio and AI assistant)
```bash
lispi -m original_example
```
And in python code:
```python
import lispi
# Create an instance of the lispi class
generator = lispi.Gen
# Specify the example notebook file
notebook_file = "original_example"
# Generate the interactive slides
generator(notebook_file)
```
## Conclusion
Lispi package provides a convenient way to convert Jupyter notebooks into interactive slides. It allows users to create engaging presentations with interactive elements easily. By following the installation and usage instructions outlined in this documentation, you can leverage this package to generate interactive slides from your Jupyter notebooks effortlessly.
Raw data
{
"_id": null,
"home_page": "",
"name": "PyGlide",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "code,live,notebook,py-scripts",
"author": "",
"author_email": "B7M <ibsnetwork001@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/8f/3f238a5fd4b423e1a655b7444ba95fc944d3ffa9b2e199c5b1bba6c25d12/pyglide-0.0.1.tar.gz",
"platform": null,
"description": "# LISPI Documentation\n\n## Introduction\n\n`lispi` (Learning Interactive Slides and PIthon) is a Python package that provides a convenient way to convert Jupyter notebooks into interactive slides. It allows users to create engaging presentations with interactive elements directly from the slides.\n\n## Installation\n\n### Install from GitHub files\nTo install `lispi` package, you can clone the repository from GitHub and modify it to your liking and install on your system. Open your terminal and run the following command:\n\n```\ngit clone https://github.com/B7M/lispi.git\n```\nNavigate to the directory containing the repository and follow these steps:\n\nMake the build file:\n\n```\npython -m build\n```\nOnce the build file is created successfully, you will see a folder named `dist` in the directory which contains `.whl` and '.tar.gz'. The name of the file will be the {package name}-{version number}-{py3-none-any.whl}. At this point run `pip install dist/{the .whl file}` command to install the package, here is an example of installing the package with `version 0.0.10`:\n\n```\npip install dist/lispi-0.0.10-py3-none-any.whl\n```\n\n\n### Install from PyPI\nTo install `lispi` package, you can use pip, the Python package installer. Open your terminal and run the following command:\n\n```\npip install lispi\n```\n## Configuration\n\nLispi provides several configuration options to customize the output slides. You can pass these options as arguments when creating an instance of the `lispi` class or running lispi from command line. Here are the available configuration options:\n\n- `audio`: Specify if you wish the output without audio (default: \"un-mute\"). If you wish to generate the output without audio, you can pass \"-m\" as the value for this argument.\n- `AI_assistant`: Specify if the output file should include an AI assistant (default: \"AI prompt is included\"). If you wish to generate the output without AI assistant, you can pass \"-p\" as the value for this argument.\n\nExample:\n\n```bash\nlispi original_example -m -p\n```\n\n```python\ngenerator = lispi(\n audio=\"False\",\n aI_assistant=\"False\"\n)\n```\n\n## Usage\nPreparation:\n- Open a Jupyter notebook in Jupyter Lab or Jupyter Notebook.\n- Add a markdown cell at the top of the notebook.\n- Use level 1 heading to specify the title of the presentation and level 2 heading to specify the author and additional information.\n- Make sure each cell is labeled with the write Slide Type (e.g. Slide, Sub-Slide, Fragment, Skip, Notes, etc.). This step is very important as it will determine the slides and the audio files that will be generated.\n- While preparing the slides you may wish to receive input from the user. Lispi allows you to receive input from the user as simple text or as executable code.\nTo do so, you should use `<div><!--Course_Text--></div>` in any slides you want to receive simple text. This HTML line will not be visible in the output slides. It will be server as a target for lispi. Similarly, to receive executable code, you can use `<div><!--Course_Code--></div>` in any slides you want to receive executable code. The package will automatically convert the input cells into interactive cells in the output slides.\n\nWe included an example notebook in the package to show you how to prepare your notebook for lispi. To access the example notebook after installing lispi `pip install lispi` in command line execute the following line `lispi original_example` this will generate a folder `output` which will contain the example notebook file. You can use this notebook to see how you can prepare your notebook for lispi. You can also use this notebook to test the package.\n### Command Line Interface\nTo use lispi, in your terminal follow these steps:\nAfter installing the package, you can use the `lispi` command to convert your Jupyter notebook into interactive slides. In your terminal, navigate to the folder containing the notebooks and run the following command:\n\n```lispi```\n\nUpon running the command, the package will prompt you with help text to show you how you can use it. Enter the name of the file press enter. The package will convert the Jupyter notebook into interactive slides and save the output HTML file in the output folder in the same directory as html file and audio file folder. If you wish to convert the notebook named `original_example.ipynb`, you will enter `original_example` and press enter. If you wish to convert the notebook without audio, you can enter `lispi -m original_example` and press enter.\n\n### Python\nIf you want to use lispi in your Python code, you can import the package and use it as a library. To use lispi, in python follow these steps:\n\n1. Import the `Gen` class from the package:\n\n ```python\n import lispi\n ```\n or \n\n ```python\n from lispi import *\n ```\n\n2. Create an instance of the `Interactive Slides Generator` class:\n\n ```python\n generator = lispi.Gen\n ```\n\n3. Specify the Jupyter notebook file you want to convert:\n\n ```python\n notebook_file = \"path/to/your/notebook.ipynb\"\n ```\n\n4. Generate the interactive slides:\n\n ```python\n generator(notebook_file)\n ```\n\n5. The package will convert the Jupyter notebook into interactive slides and save the output HTML file in the output folder in the same directory as html file and audio file folder.\n\n\n\n## Examples\n\nHere is an example that comes with the package. To run the example, in your terminal or python code provide 'original_example' as the file name.\n\n(with audio and AI assistant)\n```bash \nlispi original_example -p\n```\nor\n\n```bash\nlispi -i original_example -p\n```\n\n(without audio and AI assistant)\n```bash\nlispi -m original_example\n```\nAnd in python code:\n\n```python\nimport lispi\n\n# Create an instance of the lispi class\ngenerator = lispi.Gen\n\n# Specify the example notebook file\nnotebook_file = \"original_example\"\n\n# Generate the interactive slides\ngenerator(notebook_file)\n```\n\n## Conclusion\n\nLispi package provides a convenient way to convert Jupyter notebooks into interactive slides. It allows users to create engaging presentations with interactive elements easily. By following the installation and usage instructions outlined in this documentation, you can leverage this package to generate interactive slides from your Jupyter notebooks effortlessly.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "`PyGlide` (Python Guided Learning through Interactive Digital Education) is a python package for generating live notebooks where you can learn the content by listening to and reading from the slides at the same time you can write and execute yourown code from the slides in real time.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/B7M/lispi"
},
"split_keywords": [
"code",
"live",
"notebook",
"py-scripts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cfa287a4c04138924263980b1ff121033be5a9a2896a13bf16762cc157b18450",
"md5": "5c75ca04e0b7abcd1b8f3732fbb2ede9",
"sha256": "540899e47d709b5eaaf91443f7bacf4fef2c6ca35b6b65e3b3a7414ba13e8867"
},
"downloads": -1,
"filename": "pyglide-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c75ca04e0b7abcd1b8f3732fbb2ede9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13494,
"upload_time": "2023-08-22T03:45:06",
"upload_time_iso_8601": "2023-08-22T03:45:06.671050Z",
"url": "https://files.pythonhosted.org/packages/cf/a2/87a4c04138924263980b1ff121033be5a9a2896a13bf16762cc157b18450/pyglide-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e58f3f238a5fd4b423e1a655b7444ba95fc944d3ffa9b2e199c5b1bba6c25d12",
"md5": "23b6d41df9082a99619b302ab32dfdec",
"sha256": "a1bc657261ff0384dc052be16b2575843878ac565635b9aa0c0bd661f3899cf0"
},
"downloads": -1,
"filename": "pyglide-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "23b6d41df9082a99619b302ab32dfdec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11713,
"upload_time": "2023-08-22T03:45:08",
"upload_time_iso_8601": "2023-08-22T03:45:08.633074Z",
"url": "https://files.pythonhosted.org/packages/e5/8f/3f238a5fd4b423e1a655b7444ba95fc944d3ffa9b2e199c5b1bba6c25d12/pyglide-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 03:45:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "B7M",
"github_project": "lispi",
"github_not_found": true,
"lcname": "pyglide"
}
