ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Docs

Dependencies

One of the new features of Package Control 3.0 is support for dependencies. Dependencies are non-user-visible packages that contain binaries, shared libraries or Python modules. Dependencies are not a way to install multiple related packages. Currently no such functionality exists.

How They Work

Similar to packages, dependencies are distributed through a repository. Dependencies are always fully extracted to the user‘s Packages/ folder, using their name. Thus, dependency and package names exist in a single namespace. This means you can not have a dependency with the same name as a package.

Once the package is extracted, a custom-generated python file is added to a special package named 0_package_control_loader. For Sublime Text 3, this is a .sublime-package file, whereas for Sublime Text 2 it is just a folder. The reason for the name (and creating it as a .sublime-package file in ST3) is to ensure it is the very first non-default package that Sublime Text loads.

The generated python file looks for predefined subfolder names in the dependency folder, based on the user‘s machine. Each matching subfolder that is found will be added to Python‘s sys.path list, which is used to load modules.

The predefined subfolder names are in the formats: st{st_version}_{os}_{arch}, st{st_version}_{os}, st{st_version} and all. For example, with Sublime Text 3 on a 64bit Linux machine the following subfolders will be checked:

  1. st3_linux_x64
  2. st3_linux
  3. st3
  4. all

The valid list of Sublime Text versions is: st2 and st3. The valid list of operating systems is: windows, osx and linux. The valid list of architectures is: x32 and x64.

If for some reason you need different logic, create a single python file in the root folder of the dependency named loader.code. This file should contain python code and would be fully responsible for making any and all changes necessary to sys.path.

For ease-of-use during development of packages, a dependency may also have a .sublime-dependency file in the root of the package. This file should contain a two digit loader priority for the dependency. This allows for dependencies to control where, relative to each other, they are added to the sys.path. If a dependency has no other dependencies, it may use a low priority such as 01. For dependencies that need others, a higher number would be appropriate.

Examples

If the explanation of how dependencies work seems kind of abstract, take a moment and look at the following examples:

Publishing

Like packages, dependencies are distributed through repositories and cached in channels. See example-repository.json for the basic documentation on how to add a dependency to the repository JSON.

The dependencies in the default repository are tracked in the file repository/dependencies.json. To add a new dependency, fork the channel and submit a pull request. Be sure to use the ChannelRepositoryTools to test your addition.

Using Dependencies

To mark a package as requiring one or more dependencies, there are two options:

  1. Add a dependencies key to one of the releases - docs
  2. Add a dependencies.json file to the root of the package - docs

The dependencies.json approach will likely be more convenient for package developers since they will not be installing their own packages from a channel or repository.