CHANGELOG.md

Changes in sudospawner

1.0

1.0.0 - 2025-10-17

1.0.0 fixes compatibility with Python >=3.13 and requires Python >=3.9.

(full changelog)

API and Breaking Changes

• Remove deprecated debug_mediator config (replaced by mediator_log_level) #90 (@consideRatio, @minrk)
• Require jupyterhub 4+ and cleanup not required dependency on notebook #86 (@consideRatio, @manics, @minrk)

Enhancements made

• Let c.JupyterHub.spawner_class be configurable with "sudo" #94 (@consideRatio, @minrk)
• Replace debug_mediator with mediator_log_level #54 (@Siecje, @minrk)

Maintenance and upkeep improvements

• ci: fix declaring Python version #99 (@consideRatio)
• Add pre-commit hooks #97 (@consideRatio, @minrk)
• ci: run tests weekly to help flag issues over time #93 (@consideRatio)
• Add dependabot config to bump github actions #91 (@consideRatio, @minrk)
• Transition from tornado's gen.coroutine to async/await #89 (@consideRatio, @minrk)
• Fix Dockerfile based example of using sudospawner #88 (@consideRatio)
• Expose version and version_info directly #85 (@consideRatio)
• Transition to pyproject.toml and modenize release docs/automation #84 (@consideRatio, @manics, @minrk)
• Python 3.9-3.13 support with GitHub Actions fixes #81 (@ken-lauer, @consideRatio)
• Replace pipes with shlex #80 (@urlicht, @consideRatio, @manics)

Documentation improvements

• Fix broken link and rename examples folder to example #98 (@consideRatio)
• Refresh README for the 1.0.0 release #96 (@consideRatio, @minrk)
• docs: add dates to changelog entries #83 (@consideRatio)
• docs: fix broken badge and add typical badges #82 (@consideRatio)
• Fix URL for sudo configuration #76 (@pdebuyl, @consideRatio)
• Update running JupyterLab docs for SudoSpawner #67 (@kinow, @consideRatio)
• Fix dead link to Dockerfile in README.md #57 (@lumbric, @consideRatio)

Continuous integration improvements

• Bump actions/setup-python from 5 to 6 #101 (@consideRatio)
• Bump actions/checkout from 4 to 5 #92 (@manics)
• ci: add release workflow without pypa action #69 (@consideRatio, @minrk)
• Use GitHub Actions #66 (@kinow, @minrk)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @Frank-Steiner (activity) | @ken-lauer (activity) | @kinow (activity) | @lumbric (activity) | @mangecoeur (activity) | @manics (activity) | @minrk (activity) | @pdebuyl (activity) | @Siecje (activity) | @urlicht (activity) | @yuvipanda (activity)

0.5

0.5.2 - 2018-01-19

• Add make_preexec_fn method as an avenue for overriding pre-exec actions, e.g. setting resource limits. Default behavior is unchanged.

0.5.1 - 2017-10-11

• Fix bug preventing JupyterHub 0.8 from connecting to Spawners with default ip.

0.5.0 - 2017-09-26

• Remove deprecated code for supporting JupyterHub < 0.7. JupyterHub ≥ 0.7 is required.

0.4

0.4.1 - 2017-08-06

• Avoid invoking sudo for poll

0.4.0 - 2017-04-21

0.4 adds better error handling:

• report better errors when sudospawner fails; change unhelpful ValueError: substring not found message when parsing output fails to a more helpful message and log the unparsed data
• treat failures to signal the process as the process being missing, and log the failure, instead of raising errors

0.3

0.3.0 - 2016-10-10

• return ip, port from Spawner.start (future-compatibility, as setting ip, port directly is deprecated in JupyterHub 0.7)
• better handling of errors in the mediator
• allow overriding single-user spawn via sudospawner-singleuser script

0.2

0.2.0 - 2016-02-12

• Fixes for compatibility with jupyterhub-0.4
• Relay subprocess output to Hub, to reduce silent errors
• sudospawner executable must be in the same dir as jupyterhub-singleuser

0.1

0.1.0 - 2016-02-03

First release