SnakeBridge.Config (SnakeBridge v0.9.0)

View Source

Compile-time configuration for SnakeBridge.

Summary

Types

t()

Functions

load()

Load config from mix.exs project config and Application env.

Types

t()

@type t() :: %SnakeBridge.Config{
  auto_install: :never | :dev | :dev_test | :always,
  docs: keyword(),
  generated_dir: String.t(),
  helper_allowlist: :all | [String.t()],
  helper_pack_enabled: boolean(),
  helper_paths: [String.t()],
  inline_enabled: boolean(),
  introspector: keyword(),
  ledger: keyword(),
  libraries: [SnakeBridge.Config.Library.t()],
  metadata_dir: String.t(),
  runtime_client: module(),
  scan_exclude: [String.t()],
  scan_paths: [String.t()],
  strict: boolean(),
  verbose: boolean()
}

Functions

load()

@spec load() :: t()

Load config from mix.exs project config and Application env.

Python dependencies are specified via the python_deps key in your mix.exs project:

def project do
  [
    app: :my_app,
    version: "1.0.0",
    deps: deps(),
    python_deps: python_deps()
  ]
end

defp python_deps do
  [
    {:numpy, "1.26.0"},
    {:pandas, "2.0.0", include: ["DataFrame", "read_csv"]}
  ]
end

This approach mirrors how deps/0 works and is compatible with all installation methods (Hex, path, git).