Welcome to spin’s documentation!

Contents

• About spin
  • Spin’s plugin system
  • Spin’s configuration tree system
  • Provisioning a project using spin
  • Most Frequently Asked Questions
    • Why not …?
    • Is it necessary to run everything via spin?
    • Why YAML?
• Installation
  • Installing with pipx
  • System requirements
• Using spin
  • Writing spinfile.yaml
    • Plugin-packages
    • Local plugins
    • Interpolation
    • Environment variables
    • Extra-tasks
    • Build-rules
    • Directives
  • Writing global.yaml
  • Environment variables
  • Builtin tasks
    • schemadoc
    • system-provision
  • Troubleshooting
    • Missing system dependencies
    • Order of property overriding
• Plugin Development Guide
  • Plugin lifecycle
  • Developing plugins
  • Plugin schema
  • Plugin API
  • Conventions and guidelines
    • General recommendations
    • Configuration tree
    • Outer and inner interpreter
    • Transparency and behavior consistency
    • Secret management
    • Dependency Management
• Command Line Reference
  • spin
• Plugin API Reference
  • Defining tasks
    • task()
    • group()
    • argument()
    • option()
  • Interacting with spin
    • config()
    • invoke()
    • get_tree()
    • interpolate1()
    • interpolate()
    • namespaces()
    • toporun()
    • EXPORTS
  • Communication with the user
    • Verbosity
    • echo()
    • info()
    • debug()
    • warn()
    • error()
    • die()
  • Handling Processes
    • sh()
    • setenv()
    • Command
  • Handling state
    • Memoizer
    • memoizer()
  • Files and Path handling
    • cd()
    • copy()
    • exists()
    • mkdir()
    • mv()
    • rmtree()
    • download()
    • abspath()
    • normpath()
    • appendtext()
    • getmtime()
    • persist()
    • readbytes()
    • readlines()
    • readtext()
    • readyaml()
    • unpersist()
    • writebytes()
    • writelines()
    • writetext()
• Schema Reference
  • spin.spinfile
  • spin.project_root
  • spin.spin_dir
  • spin.launch_dir
  • spin.data
  • spin.config
  • spin.version
  • spin.project_name
  • spin.topo_plugins
  • spin.index_url
  • spin.extra_index
  • spin.hooks.test
  • spin.hooks.package
  • verbosity
  • plugins
  • plugin_packages
  • plugin_paths
  • platform.exe
  • platform.kind
  • build_rules.requirements.txt.sources
  • build_rules.requirements.txt.script
  • builtin._requires
• Release Notes
  • v3.1.0
  • Enhancements
  • Bug Fixes
  • Chores
  • v3.0.0
    • Breaking Changes
    • Bug Fixes
    • Chores
  • v2.0.2
    • Bug Fixes
    • Chores

Indices and tables

• Index

• Module Index

• Search Page