Schema Reference

spin: 'object'

Settings required for running spin. Many of these cannot be set via a spinfile or via the command line, but are computed by spin.

spin.spinfile: 'path' = 'spinfile.yaml'

The name of the configuration file for the project. This can be overridden via ‘spin -f <filename>’.

spin.project_root: 'path internal'

The path to the project directory.

spin.spin_dir: 'path internal' = '{spin.project_root}/.spin'

The absolute path to spin’s project related data. This is also the place environments are provisioned.

spin.launch_dir: 'path internal'

The directory in which spin was called.

spin.data: 'path' = '{SPIN_DATA}'

Path that points to spins data

spin.config: 'path internal' = '{SPIN_CONFIG}'

Path where to store global configuration for spin

spin.version: 'str internal'

The version of spin that is being used.

spin.project_name: 'str'

The project that is spin running on

spin.topo_plugins: 'list internal'

Topological ordered list of initialized plugins

spin.index_url: 'str' = 'https://pypi.org/simple'

The default Python package index url.

spin.extra_index: 'str'

Additional index to install plugin-packages from.

spin.hooks: 'object internal'

A dictionary mapping workflow names to lists of commands. This is automatically set up by the when argument to spin.task().

spin.hooks.test: 'list internal'

spin.hooks.package: 'list internal'

environment: 'object'

environment maps additional environment variables and their values which will added to the environment when running spin.

extra_tasks: 'object'

extra_tasks maps task names to task definitions, where task definitions support env and script keys.

verbosity: 'str internal' = 'NORMAL'

verbosity defines the level of which spin will print messages to stdout. Levels are: QUIET, NORMAL, INFO, DEBUG

plugins: 'list'

The list of plugins to import.

plugin_packages: 'list'

A list of plugin packages to install. Supports the same requirements specifiers as pip, including URLs, local file names and PEP 440 specifiers.

plugin_paths: 'list'

A list of paths to local directories containing plugin modules and their optional schemas.

platform: 'object'

Providing OS/platform-specific properties

platform.exe: 'path'

The file type of executables, “exe” on Windows and “” on non-Windows

platform.kind: 'str'

loaded: 'object internal'

Mapping between plugin names and their module objects

build_rules: 'object'

Configuration of rules for build targets.

build_rules.task docs

build_rules.task docs.sources

build_rules.doc/schemaref.rst

build_rules.doc/schemaref.rst.sources

build_rules.doc/schemaref.rst.spin

build_rules.requirements.txt: 'object'

build_rules.requirements.txt.sources: 'list'

build_rules.requirements.txt.script: 'list'

system_requirements: 'object'

The system requirements for the current project.

schema: 'object internal'

The schema shipped by spin.

builtin: 'object'

builtin._requires: 'list'