Skip to main content

JupyterLab extension for Stata syntax highlighting similar to the Stata IDE's.

Project description

jupyterlab_stata_highlight2

Github Actions Status

JupyterLab extension for Stata syntax highlighting similar to the Stata IDE's.

Requirements

  • JupyterLab >= 3.1, < 4.0

Install

pip install jupyterlab_stata_highlight2

Uninstall

pip uninstall jupyterlab_stata_highlight2

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_stata_highlight2 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

Predecessor license notices

Extension boilerplate originated in Project Jupyter's https://github.com/jupyterlab/extension-cookiecutter-js Extension content forked from Kyle Barron's https://github.com/kylebarron/jupyterlab-stata-highlight Please note their respective licenses.

Project details


Download files

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

Source Distribution

jupyterlab_stata_highlight2-0.1.2.tar.gz (318.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_stata_highlight2-0.1.2.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_stata_highlight2-0.1.2.tar.gz
Algorithm Hash digest
SHA256 00b5a177ccc90572a3508a4a9d7682f0ce3b0710c70d2e9814a0d04af17eea06
MD5 a451aa76890e40ae6671b7a791455e0e
BLAKE2b-256 50d4393a81a02bb7937d682fa6307f57a54a3d755d8ce080a39e4c5e7c24bcb8

See more details on using hashes here.

File details

Details for the file jupyterlab_stata_highlight2-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_stata_highlight2-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a6b740b24876fccd43b72134697d81b858806294f25f0bd5a4803e74f2bda7cf
MD5 60a73b24c0faee629a21c3983aab7087
BLAKE2b-256 ad0becb98da65d6869b339df17ecdb79af4e07d68ffef7d57c97927fc84838f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page