A Jupyter Widget for Niivue based on anywidget.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for aandroulakis from gravatar.com aandroulakis Avatar for hanayik from gravatar.com hanayik Avatar for manzt from gravatar.com manzt

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD-2-Clause)
  • Requires: Python >=3.9
  • Provides-Extra: dev
Classifiers
Report project as malware

Project description

ipyniivue

PyPI Version License Binder

A Jupyter Widget for Niivue based on anywidget.

Installation

Install ipyniivue using pip:

pip install ipyniivue

Usage

In a Jupyter environment:

from ipyniivue import NiiVue

nv = NiiVue()
nv.load_volumes([{"path": "images/mni152.nii.gz"}])
nv

This will render an interactive Niivue widget within your notebook.

See the basic demo to learn more.

Documentation

See the Documentation for usage.

Development

ipyniivue uses the recommended hatchling build system, which is convenient to use via the hatch CLI. We recommend installing hatch globally (e.g., via pipx) and running the various commands defined within pyproject.toml. hatch will take care of creating and synchronizing a virtual environment with all dependencies defined in pyproject.toml.

Command Cheat Sheet

Run these commands from the root of the project:

Command Description
hatch run format Format the project with ruff format . and apply linting with ruff --fix .
hatch run lint Lint the project with ruff check .
hatch run test Run unit tests with pytest
hatch run docs Build docs with Sphinx

Alternatively, you can manually create a virtual environment and manage installation and dependencies with pip:

python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

Making Changes to the JavaScript Code

This is an anywidget project, meaning the codebase is a hybrid of Python and JavaScript. The JavaScript code resides under the js/ directory and uses esbuild for bundling. Whenever you make changes to the JavaScript code, you need to rebuild the files under src/ipyniivue/static.

You have two options:

  1. Build Once: Build the JavaScript code one time:

    npm run build

  2. Start Development Server: Start a development server that automatically rebuilds the code as you make changes:

    npm run dev

    We recommend this approach for a smoother development experience.

Working with Jupyter

Once the development server is running, you can start JupyterLab or Visual Studio Code to develop the widget. When you're finished, stop the development server with Ctrl+C.

Note: To have anywidget automatically apply changes as you work, set the environment variable ANYWIDGET_HMR=1. You can set this directly in a notebook cell:

%env ANYWIDGET_HMR=1

or in the shell:

export ANYWIDGET_HMR=1

Release Process

Releases are automated using GitHub Actions via the release.yml workflow.

Steps to Create a New Release

  1. Commit Changes: Ensure all your changes are committed.

  2. Create a Tag: Create a new tag matching the pattern v*:

    git tag -a vX.X.X -m "vX.X.X"
git push --follow-tags

  3. Workflow Actions: When triggered, the workflow will:

    • Publish the package to PyPI with the tag version.
    • Generate a changelog based on conventional commits.
    • Create a GitHub Release with the changelog.

Changelog Generation

  • We generate a changelog for GitHub releases with antfu/changelogithub.
  • Each changelog entry is grouped and rendered based on conventional commits.
  • It's recommended to follow the Conventional Commits specification.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for aandroulakis from gravatar.com aandroulakis Avatar for hanayik from gravatar.com hanayik Avatar for manzt from gravatar.com manzt

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD-2-Clause)
  • Requires: Python >=3.9
  • Provides-Extra: dev
Classifiers

Release history Release notifications | RSS feed

This version

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.3

2.3.2

2.3.1

2.3.0

2.2.2

2.2.1

2.2.0

2.1.0

2.0.1

2.0.0

1.1.0

1.0.2

1.0.1

1.0.0

0.1.0.dev0 pre-release

Download files

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

Source Distribution

ipyniivue-2.4.4.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipyniivue-2.4.4-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file ipyniivue-2.4.4.tar.gz.

File metadata

  • Download URL: ipyniivue-2.4.4.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ipyniivue-2.4.4.tar.gz
Algorithm Hash digest
SHA256 34ce751a9aa342081fe1ab9e1aadcf2d5594729b45b1670bfc225eeb3888c1d9
MD5 5e17b73784d17268aead231bdcb0baec
BLAKE2b-256 74720fb5dc15a871c5706741fd2e68b6204c52321cca7148629b8be0753137a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipyniivue-2.4.4.tar.gz:

Publisher: release.yml on niivue/ipyniivue

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ipyniivue-2.4.4-py3-none-any.whl.

File metadata

  • Download URL: ipyniivue-2.4.4-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ipyniivue-2.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5e42b192a607b398c900a1e66d18aab1b41da4653a7e1641c18959bf1873cadc
MD5 3e124eb3d174d7d0e891dd4894e6e615
BLAKE2b-256 30091acb57d0225c93c9dadad025245c206bec17238eddac0bd9c49bc2240999

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipyniivue-2.4.4-py3-none-any.whl:

Publisher: release.yml on niivue/ipyniivue

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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