Skip to main content

Run DosBox in jupyterlab

Project description

jupyterlab_dosbox

Github Actions Status

Dosbox in Jupyterlab

Run DosBox in jupyterlab. Built on js-dos and uses the js-dos 7.xx modules.

This exposes a pretty simple interface to a WASM-compiled DosBox instance. You can get screenshots, coredumps, and you can send commands. It will download some wasm assets off the web using pooch.

As of right now, the DosBox instance does not listen to key and mouse events!

The examples in the examples directory show how to get a coredump, take a screenshot, and send zip files.

There are a bunch of rough edges! But, you can browse the files in your filesystem with a file browser panel on the left, and you can inspect the memory.

Some things that are on the roadmap:

  • Better interaction with the instance, including trapping and sending appropriate browser events
  • Saving and restoring file system and memory instances (i.e., machine state)
  • Better interface for inspecting core dumps
  • Sound and video capture
  • All-around polish on the interface (like, why aren't there any icons?!)

Requirements

  • JupyterLab >= 3.0
  • Pooch
  • numpy, for memory access

Install

pip install jupyterlab_dosbox

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_dosbox directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab_dosbox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyterlab-dosbox, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size jupyterlab_dosbox-0.1.0.tar.gz (870.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page