Skip to main content

A widget library for controlling Nao

Project description

ipynao

Build Status lite-badge

A widget library for controlling Nao

Video of ipynao in JupyterLite

Installation

You can install using pip:

pip install ipynao

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] ipynao

Development Installation

Create a dev environment:

conda create -n ipynao-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipynao-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 ipynao
jupyter nbextension enable --sys-prefix --py ipynao

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.

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

pip install tbump
tbump <new-version>

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ipynao-0.8.9-py3-none-any.whl (397.4 kB view details)

Uploaded Python 3

File details

Details for the file ipynao-0.8.9-py3-none-any.whl.

File metadata

  • Download URL: ipynao-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 397.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.12

File hashes

Hashes for ipynao-0.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a86aced76b02f5634fa41dce074aab845995244b0518799c0a5f4118f959886e
MD5 b0af140c679cb2175426cdbe0b3433fa
BLAKE2b-256 2fd01ca07e9b63a966041cd6d8ef3ce82e696899027e2a8a928c03451e224670

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