Skip to content

README.md

Latest commit

 

History

History
59 lines (38 loc) · 3.44 KB

README.md

File metadata and controls

59 lines (38 loc) · 3.44 KB

LabConstrictor

DOI LabConstrictor Comic

LabConstrictor turns your Jupyter notebooks into installable desktop applications. This lets users launch your work right away, without needing to use Python, pip, or any terminal commands.

This GitHub template handles everything for you. It packages your notebooks, builds installers for different platforms, and provides a simple, user-friendly Welcome dashboard. Your users can open your app with a double-click, while you keep a versioned, reproducible workflow.

🎯 Who is this for?

LabConstrictor is ideal for:

  • Researchers sharing reproducible analysis pipelines or lab tools.
  • Developers shipping interactive notebooks to non-technical users.
  • Educators running workshops where setup time must be near zero.

✨ LabConstrictor's Features

  • Easy Configuration: Includes a web form to easily configure repo settings, manage dependencies, and brand your application without manual editing.
  • Cross-Platform: Automatically builds .exe (Windows), .pkg (macOS), and .sh (Linux) installers.
  • Auto-Hide Code: Code cells can be hidden, allowing users to see a clean, "app-like" interface, but still being able to reveal code if needed.
  • Dependency Guardrails: automatic workflows merge and validate requirements, catching conflicts before you release.
  • Version Control: Helper cells track versions and alert users when an update is available.

📸 The User Experience

LabConstrictor Summary GIF

🚀 Before Getting Started

Please read the Before Getting Started Guide to familiarise yourself with the LabConstrictor workflow and requirements.

⚡ Quick Start

Go from notebook to installer in minutes.

1. Create a New Repository from this Template

2. Initialise your repository

3. (Optional) Upload external code

4. Upload Your Notebooks

5. Create Executable Installers

Requirements: You only need a GitHub account and the Jupyter notebooks you want to distribute.

Need help writing notebooks that run well in both Colab and JupyterLab? See the notebook portability guide.

🤝 Contributing

We welcome contributions, including bug fixes, UX improvements, or new packaging strategies. Please read the Contributing Guidelines before submitting PRs.

📢 Community

Using LabConstrictor? We’d love to feature your project! Open an issue to let us know about your use case.

✍️ Citation

If you use LabConstrictor in your research, please cite the project to support its development:

Iván Hidalgo-Cenalmor, Marcela Xiomara Rivera Pineda, Bruno M. Saraiva, Ricardo Henriques, and Guillaume Jacquemet. Packaging Jupyter notebooks as installable desktop apps using LabConstrictor. arXiv preprint 2026 DOI: https://doi.org/10.48550/arXiv.2603.10704