Skip to main content

No project description provided

Project description

ScrumMD

Logo

ScrumMD started with a question: What if we could have a scrum board driven entirely by md files and the CLI, and use it with git?

I know that it's going to be of niche use, but it opens up a number of great ways to do the scrum process. For instance:

  • You can run standup for sprint1 with:
vim `sbl -b sprint1`
  • You can manage your cards with git...
  • ... and can add them in the repository that they are for
  • It's all text - so integrate with whatever you want

The very basics are that you have a scrum folder, and you can put cards inside it. A card is very simple - it's just a markdown file with at least a summary field. For instance -

---
Summary: Make the thing
---

# Description

Take the steps to make the thing

# Dependencies

-   [[thing02]]
-   [[thing03]]

would be a completely valid card that can be explored with ScrumMD. But - per the documentation - it does a bunch more!

There's also some funky other tools like sboard that let you view a visual representation of the Scrum board in the console - for instance:

$ sboard --group-by status
|not fully defined  |ready              |in progress        |in testing         |done               |None               |
|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|
|cli008             |cli028             |cli034             |                   |cli018             |v0-1               |
|Permit newlines in…|Allow underline he…|Show scrum board o…|                   |`sbl` Group By     |Items remaining to…|
|                   |                   |                   |                   |                   |                   |
|cli029             |cli032             |                   |                   |cli019             |                   |
|Allow subheadings …|Write access to pr…|                   |                   |String property af…|                   |
|                   |                   |                   |                   |                   |                   |

Documentation

Find it all over on Read The Docs. There's a fair bit of detail, and a tutorial for getting started.

License

This is published under the GNU General Public License v3.0. I am willing to discuss making it available under another license, or providing pai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scrummd-0.1.2.tar.gz (567.7 kB view hashes)

Uploaded Source

Built Distribution

scrummd-0.1.2-py3-none-any.whl (570.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page