ScrumMD 0.1.2

Welcome to the documentation for ScrumMD.

ScrumMD has tools for self-organising teams to manage cards written in markdown. As the name suggests, it was originally designed for teams to use in the Scrum process, but it can also be used for:

• Kanban style processes

• Tracking bugs and issues

• Tracking decisions or questions

It still has room to grow, but the fundamental tools are there to use it. Getting Started shows you how to use it, and offers suggestions about how to create a workflow around it.

The CLI commands and library are documented here. It is recommended that you use the library with Python if you’re wanting to automate parts of the process rather than relying on the output of the CLI commands.

Contents:

• Getting Started
  • Installation
  • Concepts
  • Tutorial: Basics of using ScrumMD
• ScrumMD Commands
  • sbl
  • scard
  • sboard
  • svalid
  • sbench
• Cards
  • Example card
  • Alternative Heading Style
  • Card References
  • Fields
• Configuration
  • Configuration files
  • Supported fields
  • Example configuration file
• scrummd package
  • Submodules
  • scrummd.card module
  • scrummd.collection module
  • scrummd.config module
  • scrummd.config_loader module
  • scrummd.const module
  • scrummd.exceptions module
  • scrummd.sbench module
  • scrummd.sbl module
  • scrummd.scard module
  • scrummd.source_md module
  • scrummd.svalid module
  • Module contents
• ScrumMD Versioning

Indices and tables

• Index

• Module Index

• Search Page