Skip to main content

A Jupyter Widget Library for accessing the server's URL

Project description

Binder

ipyurl

Build Status codecov

A Jupyter Widget Library for accessing the server's URL

Installation

You can install using pip:

pip install ipyurl

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:

jupyter nbextension enable --py [--sys-prefix|--user|--system] ipyurl

Development Installation

Create a dev environment:

conda create -n ipyurl-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipyurl-dev

Install the python. This will also build the TS package.

pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:

jupyter labextension develop --overwrite .
yarn run build

For classic notebook, you need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyurl
jupyter nbextension enable --sys-prefix --py ipyurl

Note that the --symlink flag doesn't work on Windows, so you will here have to run the install command every time that you rebuild your extension. For certain installations you might also need another flag instead of --sys-prefix, but we won't cover the meaning of those flags here.

How to see your changes

Typescript:

If you use JupyterLab to develop then 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 widget.

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

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

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

ipyurl-0.1.3.tar.gz (734.5 kB view details)

Uploaded Source

Built Distribution

ipyurl-0.1.3-py2.py3-none-any.whl (762.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ipyurl-0.1.3.tar.gz.

File metadata

  • Download URL: ipyurl-0.1.3.tar.gz
  • Upload date:
  • Size: 734.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for ipyurl-0.1.3.tar.gz
Algorithm Hash digest
SHA256 080854c36a478487633fdeeae7552e8269b11b1f97f7971f433375f5faa55908
MD5 14c65ae4164e5bee737a0e4ec93f41ff
BLAKE2b-256 57a12bbbee37a648f0c068b3f7daab7e271288b33004beb23e159f40554a6686

See more details on using hashes here.

Provenance

File details

Details for the file ipyurl-0.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: ipyurl-0.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 762.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for ipyurl-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 952ad60ca769ef98be55309edb4596da6bc689d57e5faa7b1d2bccc9e53e7e5e
MD5 8c53524c05e0aac4eef259d1165dd523
BLAKE2b-256 5d47a862000c16d3fa0d51b38a477a14888c83dbbb3a626efd7c2d0e0b142bab

See more details on using hashes here.

Provenance

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