Pluto and package loading

General Usage
1

Hey all, I am observing a weird behavior from Pluto. While trying to load the Bandits package (available at Bandits ), I realised the package was not declared in the registry. This forced me to add the command Pkg.add(url=“GitHub - rawls238/Bandits.jl: Implementation of multi-armed bandits in Julia”) to my notebook. Although it loads the Bandits package, it cannot load any other package with the “using” keyword. I must use Pkg.add() Is that expected behavior? Did I miss a configuration?

2

That’s how Pluto works. Either it automatically adds all packages before using and removes them once the cell with using is deleted, but you can only use registered packages, or you go with the general Pkg mechanism.
A workaround is to create a local registry (see LocalRegistry.jl), register anything you need there, add it in REPL through pkg"registry add myregistry", and then Pluto can use packages registered there the same way as the packages from the General registry.

3

And if you want to share the notebook, you need to add

pkg"registry add myregistry"

inside the notebook?

4

I tried using

begin
	Pkg.pkg"registry add https://github.com/myLocalRegistry"
	using mylocalPkg
end

it works on my local machine but does not with CI from GitHub - JuliaPluto/static-export-template: A template to automatically convert Pluto notebooks to an HTML website with GitHub Pages. Demo page:.
It just fails to install.
I also get

┌ Warning: Pkg operation failed. Updating registries and trying again...
└ @ GracefulPkg /srv/julia/pkg/packages/GracefulPkg/LmTcK/src/apply strategies.jl:92
5

It seems it cannot be done from Pluto with the native pkg management, see:

and

6

I’ve just discovered this pattern

try
	using Bandits
catch notfound
	using Pkg
	RegistrySpec(url = "https://github.com/myLocalRegistry.git") |> Pkg.Registry.add
	error("The registry https://github.com/myLocalRegistry has been added; you need to restart your Pluto session")
end

That way, if the registry has been added, Pluto simply loads the package. Otherwise, it adds the registry before showing a message asking to restart the notebook.
Note that “Restart notebook” button which shows would not suffice. One needs to go to Pluto main menu, kill the notebook from there and start it again.

1 Like
7

That should work thanks. However, in terms of user experience, it is not fun!

8

Hi!

In the Julia REPL, you can use Pluto.activate_notebook_environment("../path/to/notebook.jl"). After this command, you can use the Pkg REPL ] to inspect and modify the notebook package environment. From here, you can add a local package (from path or from git URL), without needing a local registry.

Learn more about activate_notebook_environment: 📦 Packages: advanced – Pkg.activate in a cell — Pluto.jl

Future

I am also working on adding functionality for this directly into Pluto’s UI: 📋 Guided Project.toml editor by fonsp · Pull Request #3218 · fonsp/Pluto.jl · GitHub

3 Likes