Skip to content

deeplabcut-docker: version 0.1.0#3351

Merged
MMathisLab merged 5 commits into
jaap/update-dlc-dockerfrom
jaap/release_deeplabcut_docker
May 29, 2026
Merged

deeplabcut-docker: version 0.1.0#3351
MMathisLab merged 5 commits into
jaap/update-dlc-dockerfrom
jaap/release_deeplabcut_docker

Conversation

@deruyter92
Copy link
Copy Markdown
Collaborator

@deruyter92 deruyter92 commented May 29, 2026

Version bump, for releasing deeplabcut-docker 0.1.0

See changelog below

Caution

Merge this PR into main before making the latest release.


v0.1.0 — 2026-05-29

This release revives and modernises the deeplabcut-docker helper, which was
not actively maintenance and was broken for the Jupyter images on Docker Hub.
The vendored shell script (deeplabcut_docker.sh) has been replaced with
a pure-Python implementation, and the package setup has been modernised.

Breaking changes / migration

  • The package now requires Python ≥ 3.10.
  • setup.cfg / MANIFEST.in have been replaced by pyproject.toml.
    Re-install from the new package to pick up the updated entry point.

New features

  • Pure-Python rewrite — replaced the vendored shell script with a single
    deeplabcut_docker.py module; no shell dependency required.
  • --image flag — pass an arbitrary repo:tag or digest to override the
    default image selection from DLC_VERSION / CUDA_VERSION.
  • Local image support — skips the registry pull when a matching image is
    already present locally (or when a specific version/image is requested).
  • Supplementary group forwarding — all supplementary groups of the current
    host user are forwarded into the container via --group-add.
  • Jupyter image validation — warns at startup when the pulled image does
    not appear to have a Jupyter entrypoint.
  • Configurable Docker binary — override via DOCKER environment variable
    (e.g. DOCKER="sudo docker").
  • Token privacy — the notebook token is no longer echoed to the terminal by
    default; users are instructed to use the value of NOTEBOOK_TOKEN instead.

Security

  • Empty-token warning — setting NOTEBOOK_TOKEN= (empty string) disables
    Jupyter token authentication. deeplabcut-docker notebook now logs a
    prominent warning in this case.

Bug fixes

  • Fixed broken Jupyter image support on the current Docker Hub tags.
  • Fixed default user home directory (/home/{user} instead of root).
  • Fixed notebook token not being propagated into the container environment.
  • Improved error logging and exit-status propagation from docker subprocesses.

Infrastructure

  • Replaced setup.cfg + MANIFEST.in with pyproject.toml.
  • Added LICENSE (LGPL-3.0) and Makefile for local build and PyPI release.

Comment thread docker/package/changelog/v0.1.0.md Outdated
Comment thread docker/package/changelog/v0.1.0.md Outdated
deruyter92 and others added 2 commits May 29, 2026 18:01
@deruyter92 deruyter92 requested a review from C-Achard May 29, 2026 16:03
@deruyter92 deruyter92 marked this pull request as ready for review May 29, 2026 16:03
@MMathisLab MMathisLab merged commit 2a123a0 into jaap/update-dlc-docker May 29, 2026
3 checks passed
@MMathisLab MMathisLab deleted the jaap/release_deeplabcut_docker branch May 29, 2026 18:21
deruyter92 added a commit that referenced this pull request Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants