[go: up one dir, main page]

Skip to content
This repository has been archived by the owner on Sep 20, 2021. It is now read-only.
/ random-standup-py Public archive

Eliminate awkward pauses in standups in Python 🐍

License

Notifications You must be signed in to change notification settings

jidicula/random-standup-py

Repository files navigation

Build Code style: black PyPI

🎲random-standup-py🐍

Do you have awkward pauses in your standups because no one wants to give their update next? Why not have a defined order? To make it fair, why not also 🎲randomize🎲 that order!

You really should use the Go version of this tool. This Python version was developed solely as a comparison exercise for the package publishing process.

Do you find this useful?

Star this repo!

Do you find this really useful?

You can sponsor me here!

Usage

  1. Get the tool with pip install random-standup.

  2. Create a team roster in a TOML file, following the format in example-roster.toml:

[Subteam-1]
members = [
        "Alice",                # TOML spec allows whitespace to break arrays
        "Bob",
        "Carol",
        "David"
        ]

["Subteam 2"]                   # Keys can have whitespace in quoted strings
members = ["Erin", "Frank", "Grace", "Heidi"]
  1. standup example-roster.toml

Output

$ standup example-roster.toml
2021-03-25
## Subteam-1
Alice
Bob
David
Carol

## Subteam 2
Erin
Grace
Frank
Heidi

Building from main

  1. Clone and cd into the repo.
  2. Install Poetry.
  3. poetry install
  4. poetry run standup example-roster.toml

Run tests with poetry run pytest -v