Using tools istalled into “standard” namespace

The “standard” namespace for pip-managed SCons tools is assumed to be sconstool namespace. In the following examples we assume that tools are installed as namespaced packages, under sconstool namespace. This is exactly how all the tools developed by the original author of the scons-tool-loader get installed.

For example, the following code

pip install scons-tool-clang

will install clang tool as sconstool.clang package. Once installed, it may be used in a SCons script by extending default toolpath and loading the tool to the construction environment

# SConstruct
import sconstool.loader
sconstool.loader.extend_toolpath()
env = Environment(tools=['default', 'sconstool.clang'])
env.Program('test.c')

If, for some reason, fully qualified package name can’t be used as the tool name, one may use “transparent” mode when extending toolpath

# SConstruct
import sconstool.loader
sconstool.loader.extend_toolpath(transparent=True)
env = Environment(tools=['default', 'clang'])
env.Program('test.c')

The above code will still load the sconstool.clang tool.

Using tools installed into “non-standard” namespaces

Suppose, some tools get installed into vendor namespace. For example, vendor.foo and vendor.bar are installed somewhere under sys.path. These tools may be made visible to scons by using namespace parameter, and scan.

# SConstruct
import sconstool.loader
sconstool.loader.extend_toolpath(namespace='vendor', scan=True)
env = Environment(tools=['default', 'sconstool.clang', 'vendor.foo', 'vendor.bar'])
# ...