Skip to content

v0.3.0
Compare
Choose a tag to compare
@github-actions github-actions released this 23 Nov 22:55
· 156 commits to main since this release
v0.3.0
29d9f5b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

PlutoSliderServer v0.3.0

Big new features

🌟 Documentation

Finally!! There is a lot of documentation now, including:

  • A much better README (which explains the next items).
  • Awesome docstrings for run_directory and friends, showing all possible options.
  • An automatically generated sample TOML file: run PlutoSliderServer.show_sample_config_toml_file() in your REPL.

🌟 Watch folder for changes

After scanning a directory for notebook files, you can ask Pluto to continue watching the directory for changes. When notebook files are added/removed, they are also added/removed from the server. When a notebook file changes, the notebook session is restarted.

This works especially well when this directory is a git-tracked directory. When running in a git directory, PlutoSliderServer can keep git pulling the directory, updating from the repository automatically.

See the SliderServer_watch_dir option and PlutoSliderServer.run_git_directory.

🌟 Continuous Deployment

The result is a Continuous Deployment setup: you can set up your PlutoSliderServer on a dedicated server running online, synced with your repository on github. You can then update the repository, and the PlutoSliderServer will update automatically.

The alternative is to redeploy the entire server every time a notebook changes. We found that this setup works fairly well, but causes long downtimes whenever a notebook changes, because all notebooks need to re-run. This can be a problem if your project consists of many notebooks, and they change frequently.

See PlutoSliderServer.run_git_directory.

Breaking changes:

  • A new setting, Export_watch_dir will be set to true by default (in 0.3.1, oops...), which will enable watching the directory for changes. Set this to false explicitly if you need to disable this behaviour.
  • The default behaviour of Export_output_dir changed: if you are also running a slider server, the default will be an empty temporary directory. See the docstring for run_directory for more info!
  • In the run_directory function, the keyword arguments run_server,static_export have been moved to our configurations: SliderServer_enable, Export_enable, resp. (But you probably didn't use this keyword argument.)

I am not aware of any other breaking changes, but there might be more (please let me know), since this is a big rewrite of the internals!

Enjoy! 🎈

Diff since v0.2.7

Merged pull requests:

  • Watch folder for notebook changes and update automagically (#31) (@fonsp)

Contributors

fonsp and pankgeorg
Assets 2
Loading