jupypress 0.1.0__tar.gz

jupypress-0.1.0/.eslintrc.json

@@ -0,0 +1,28 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "no-unused-vars": "off",
+    "no-useless-escape": "off",
+    "no-control-regex": "off",
+    "@typescript-eslint/no-namespace": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "warn"
+  }
+}

jupypress-0.1.0/.gitignore

@@ -0,0 +1,90 @@
+# .gitignore for jupypress
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+pip-wheel-metadata/
+__pypackages__/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Node/JS
+node_modules/
+.yarn/
+*.tsbuildinfo
+*.d.ts
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnp/
+.pnp.js
+.package-lock.json # because we use jlpm (yarn instead of npm)
+
+# TypeScript build output
+lib/
+
+# Hatch
+.hatch/
+
+# pytest
+.pytest_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+
+# Jest coverage
+coverage/
+
+# OS
+.DS_Store
+.env
+.env.*
+.cache/
+
+# Local tools (act binary)
+bin/
+
+# Local AI/agent tooling state
+.agents/
+.codex/
+.playwright-mcp/
+
+# Prompts (local dev only)
+.github/prompts/
+
+# Compiled labextensions and static assets
+jupypress/labextension/
+
+# Reference
+reference/

jupypress-0.1.0/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "arrowParens": "always"
+}

jupypress-0.1.0/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupypress-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to JupyPress will be documented in this file.
+
+This project follows semantic versioning once public releases begin.
+
+## 0.1.0 - Initial Release
+
+- Add JupyterLab extension for building slide decks from notebook metadata.
+- Add JupyterLab-backed preview and present modes using notebook output areas.
+- Add standalone HTML export for static, shareable presentations.
+- Add slide layouts, theming, keyboard navigation, and live code execution support.

jupypress-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,23 @@
+# Code of Conduct
+
+JupyPress contributors are expected to keep project discussions professional, constructive, and focused on improving the software.
+
+## Expected Behavior
+
+- Be respectful of different experience levels and use cases.
+- Provide actionable feedback.
+- Keep issues and pull requests focused on the technical topic.
+- Assume good intent while still being clear about defects, risks, and tradeoffs.
+
+## Unacceptable Behavior
+
+- Harassment, intimidation, or personal attacks.
+- Dismissive or discriminatory language.
+- Publishing private information without permission.
+- Repeated off-topic or disruptive comments.
+
+## Enforcement
+
+Maintainers may edit, hide, or remove comments; close issues; reject contributions; or block participants when needed to keep the project usable for contributors and users.
+
+Report conduct concerns through GitHub issue moderation tools or directly to the maintainers if contact information is available.

jupypress-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,126 @@
+# Contributing to JupyPress
+
+We welcome contributions! Here's how to get started.
+
+## Code of Conduct
+
+Be respectful and inclusive. We're building a welcoming community.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork
+3. Follow [DEVELOPMENT.md](docs/DEVELOPMENT.md) for setup
+4. Create a feature branch: `git checkout -b feature/my-feature`
+
+## Development Workflow
+
+See [DEVELOPMENT.md](docs/DEVELOPMENT.md) for the full setup and dev-cycle instructions.
+
+### Making Changes
+
+1. Write code following the style guide
+2. Write tests for new features
+3. Rebuild and reinstall: `python -m build && pip install --force-reinstall ./dist/jupypress-0.1.0-py3-none-any.whl`
+4. Ensure all tests pass: `hatch run test && jlpm run test`
+5. Format code: `jlpm run format`
+6. Lint: `jlpm run lint` and `hatch run lint`
+
+### Testing
+
+```bash
+# Python tests
+hatch run test
+
+# JavaScript tests
+jlpm run test
+
+# Watch mode (JS)
+jlpm run test:watch
+```
+
+### Code Style
+
+- **Python**: PEP 8, enforced by `ruff`
+- **TypeScript**: ESLint + Prettier
+- **React**: Functional components with hooks
+- **CSS**: CSS variables for theming
+
+### Commit Messages
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat: add new layout type
+fix: correct slide ordering bug
+docs: update theming guide
+test: add tests for cell renderer
+chore: update dependencies
+```
+
+## Submitting Changes
+
+1. Push to your fork
+2. Create a Pull Request
+3. Describe what your PR does
+4. Link any related issues
+5. Ensure CI passes
+6. Request review
+
+## Adding Features
+
+### New Slide Layouts
+
+1. Add to `LAYOUTS` in `src/components/LayoutSelector.tsx`
+2. Add CSS in `jupypress/templates/static/css/base.css`
+3. Update `slide_builder.py` validation
+4. Write tests
+
+### New Themes
+
+1. Create `jupypress/templates/themes/my-theme/theme.css`
+2. Define CSS variables
+3. Add tests
+4. Document in README
+
+### New Renderers
+
+1. Extend `CellRenderer` in `jupypress/cell_renderer.py`
+2. Add MIME type handler
+3. Write tests with sample outputs
+
+## Documentation
+
+- Update README.md for user-facing changes
+- Add docstrings to Python functions
+- Add JSDoc comments to TypeScript
+- Update docs/DEVELOPMENT.md for setup changes
+
+## Performance
+
+- Profile before optimizing
+- Consider notebook size (large notebooks should still export quickly)
+- Minimize CSS/JS bundle size
+- Cache theme parsing
+
+## Accessibility
+
+- Ensure keyboard navigation works
+- Add ARIA labels to UI components
+- Test with screen readers
+- Maintain color contrast ratios
+
+## Security
+
+- Validate file paths (prevent directory traversal)
+- Escape HTML properly
+- Don't execute untrusted code by default
+- Review dependencies for vulnerabilities
+
+## Questions?
+
+- Check existing issues
+- Start a discussion
+- Contact maintainers
+
+Thank you for contributing!

jupypress-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+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.

jupypress-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+recursive-include jupypress/templates *
+recursive-include jupypress/labextension *
+recursive-include jupypress *.py
+global-exclude node_modules
+global-exclude .yarn
+global-exclude .git
+global-exclude __pycache__
+global-exclude *.pyc
+global-exclude .pytest_cache
+global-exclude .ruff_cache

jupypress-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+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`.

jupypress-0.1.0/README.md

@@ -0,0 +1,105 @@
+# 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`.

jupypress-0.1.0/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Security fixes are provided for the latest released version of JupyPress.
+
+## Reporting a Vulnerability
+
+Please report security issues using GitHub private vulnerability reporting if it is enabled for the repository. If private reporting is not available, open a GitHub issue with a minimal description and avoid including exploit details publicly.
+
+Include:
+
+- Affected JupyPress version
+- JupyterLab and Python versions
+- Reproduction steps
+- Expected and actual behavior
+- Any relevant notebook or export configuration, with sensitive data removed
+
+Maintainers will confirm receipt, assess impact, and coordinate a fix before public disclosure where appropriate.