Snakepit.PythonPackages (Snakepit v0.8.7)

Package installation and inspection for Snakepit-managed Python runtimes.

Uses uv when available or configured, with pip as the fallback.

Examples

Snakepit.PythonPackages.ensure!({:list, ["numpy~=1.26", "scipy~=1.11"]})

{:ok, :all_installed} =
  Snakepit.PythonPackages.check_installed(["numpy~=1.26", "scipy~=1.11"])

{:ok, metadata} = Snakepit.PythonPackages.lock_metadata(["numpy~=1.26"])

Snakepit.PythonPackages.ensure!({:file, "requirements.txt"}, upgrade: true)

Summary

Types

requirement()

requirements_spec()

Functions

check_installed(requirements, opts \\ [])

Check which packages are installed.

ensure!(spec, opts \\ [])

Ensure all packages in the requirements spec are installed.

install!(requirements, opts \\ [])

Install the given package requirements.

installer()

Return the active installer (:uv or :pip).

lock_metadata(requirements, opts \\ [])

Return package metadata for lockfiles.

Types

requirement()

@type requirement() :: String.t()

requirements_spec()

@type requirements_spec() :: {:list, [requirement()]} | {:file, Path.t()}

Functions

check_installed(requirements, opts \\ [])

@spec check_installed(
  [requirement()],
  keyword()
) :: {:ok, :all_installed} | {:ok, {:missing, [requirement()]}}

Check which packages are installed.

Returns {:ok, :all_installed} when every requirement is present, or {:ok, {:missing, requirements}} when any are missing.

ensure!(spec, opts \\ [])

@spec ensure!(
  requirements_spec(),
  keyword()
) :: :ok | no_return()

Ensure all packages in the requirements spec are installed.

Options:

:upgrade - upgrade matching packages
:quiet - suppress installer output
:timeout - install timeout in ms

install!(requirements, opts \\ [])

@spec install!(
  [requirement()],
  keyword()
) :: :ok | no_return()

Install the given package requirements.

Prefer ensure!/2 unless you already know which requirements are missing.

installer()

@spec installer() :: :uv | :pip

Return the active installer (:uv or :pip).

lock_metadata(requirements, opts \\ [])

@spec lock_metadata(
  [requirement()],
  keyword()
) :: {:ok, map()} | {:error, term()}

Return package metadata for lockfiles.

The result maps package name to %{version: version, hash: hash} entries.