Metadata-Version: 2.4
Name: jupypress
Version: 0.1.0
Summary: A JupyterLab extension for converting notebooks into HTML slide presentations
Project-URL: Homepage, https://github.com/andibuwono/jupypress
Project-URL: Repository, https://github.com/andibuwono/jupypress
Project-URL: Issues, https://github.com/andibuwono/jupypress/issues
Project-URL: Documentation, https://github.com/andibuwono/jupypress#readme
Project-URL: Changelog, https://github.com/andibuwono/jupypress/blob/main/CHANGELOG.md
Author: JupyPress Contributors
License: BSD 3-Clause License
        
        Copyright (c) 2026, JupyPress Contributors
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: html,jupyter,jupyterlab,presentation,slides
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Requires-Dist: jinja2>=3.1.0
Requires-Dist: jupyter-core>=5.0.0
Requires-Dist: jupyter-server<3,>=2.0.0
Requires-Dist: markdown-it-py>=3.0.0
Requires-Dist: nbconvert>=7.8.0
Requires-Dist: nbformat>=5.9.0
Requires-Dist: pygments>=2.16.0
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: test
Requires-Dist: jupyter-server[test]>=2.0.0; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# JupyPress

JupyPress is a JupyterLab extension for turning notebooks into HTML slide presentations.

It supports two output paths:

- JupyterLab-backed preview and present modes for live notebook outputs, widgets, and live code execution.
- Standalone HTML export for static, shareable presentations that do not require a running kernel.

## Requirements

- Python 3.10 or newer
- JupyterLab 4.x
- A modern Chromium, Firefox, or Safari browser

## Installation

```bash
pip install jupypress
jupyter lab
```

Open a notebook, then use the JupyPress toolbar button or the command palette command `JupyPress: Open Editor`.

## Basic Usage

1. Create slides in the JupyPress editor.
2. Choose a slide layout.
3. Assign notebook cells to slide slots.
4. Use preview for JupyterLab-backed rendering.
5. Use present mode for a browser presentation backed by the active notebook session.
6. Export to HTML for a static file that can be opened without JupyterLab.

## Features

- Slide metadata stored directly in the notebook.
- Built-in layouts for title, content, two-column, and multi-row slides.
- JupyterLab-backed preview and present modes using notebook output areas.
- Static HTML export with embedded presentation CSS and navigation.
- Theme support through CSS variables.
- Markdown, code, rich outputs, images, Plotly, Leaflet/Folium, and saved widget output support.
- Live code execution in JupyterLab-backed presentation mode.

## Output Modes

### Preview and Present

Preview and present modes run inside the JupyterLab environment and render assigned cells with JupyterLab output areas. This is the right mode for live notebook work, active kernels, widgets, and outputs that need JupyterLab renderers.

### HTML Export

HTML export creates a standalone static presentation. The exported file is designed for sharing and viewing without JupyterLab. Dynamic widget kernels are not available in this mode, but saved/static DOM output is included where possible.

## Screenshots

Release screenshots are stored under `docs/images/`:

- `docs/images/editor.png`
- `docs/images/export-html.png`
- `docs/images/launch.png`
- `docs/images/present-livecode.png`

See `docs/images/README.md` for the intended use of each capture.

## Development

```bash
git clone https://github.com/andibuwono/jupypress.git
cd jupypress
jlpm install
jlpm run build:labextension
python -m build
pip install --force-reinstall ./dist/jupypress-0.1.0-py3-none-any.whl
jupyter lab
```

Use `jlpm` rather than `npm`; JupyterLab manages the Yarn environment.

See:

- `docs/DEVELOPMENT.md` for local setup and development workflow.
- `docs/BACKEND_STRUCTURE.md` for the Python backend map.
- `docs/FRONTEND_STRUCTURE.md` for the TypeScript/React frontend map.
- `docs/TEST.md` for test commands.
- `docs/theming.md` for theme variables.

## Testing

```bash
hatch run test
jlpm run test
jlpm run build:labextension
```

## Release

See `docs/RELEASE.md` for the PyPI and GitHub release checklist.

## Contributing

Contributions are welcome. See `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`.

## License

JupyPress is distributed under the BSD 3-Clause License. See `LICENSE`.
