Documentation ¶
Index ¶
- Variables
- func BoardFor(m *trello.Member, s string) (board *trello.Board, err error)
- func ChecklistTitleFromAttributes(title string, week int, created *time.Time, estDuration *string, ...) string
- func CreateEmptyMonthlyRetrospective(summaryIn io.Reader, reviewOut io.Writer) error
- func CreateEmptyWeeklyRetrospective(summaryIn io.Reader, reviewOut io.Writer) error
- func DailyMaintenance(user, appkey, authtoken string) error
- func DumpSummaryForWeek(user, appkey, authtoken string, year, week int, out io.Writer) error
- func DumpSummaryForWeekFromHistory(user, appkey, authtoken string, week int, out io.Writer) error
- func GenerateSummaryForMonth(user, appkey, authtoken string, year, month int, summaryIn [][]byte, ...) error
- func GenerateSummaryForYear(year int, summaryIn [][]byte, out io.Writer) error
- func GetAttributesFromChecklistTitle(name string) (title string, week int, created *time.Time, estDuration *string, ...)
- func GetTitleAndAttributes(card *trello.Card) (title string, created *string, period *string)
- func ListFor(cl *Client, b string, l string) (*trello.List, error)
- func MinutelyMaintenance(user, appkey, authtoken string) error
- func MonthlyCleanup(user, appkey, authtoken string) error
- func MorningRemind(user, appkey, authtoken, sendgridAPIKey, userEmail string) error
- func VisualizeMonthlyRetrospective(summaryIn, reviewIn io.Reader, visOut io.Writer) error
- func VisualizeWeeklyRetrospective(summaryIn, reviewIn io.Reader, visOut io.Writer) error
- func VisualizeWeeklySummariesForMonthly(summaryIn io.Reader, visOut io.Writer) error
- func VisualizeYearlyPlanSummary(summaryIn io.Reader, visOut io.Writer) error
- func Weekly(user, appkey, authtoken string) error
- func WeeklyCleanup(user, appkey, authtoken string) error
- type Board
- type BoardAndList
- type CardAttrs
- type Client
- func (cl *Client) AddComment(cardID string, comment string) (*WFTask, error)
- func (cl *Client) AddMonthlyGoal(title string) error
- func (cl *Client) AddWeeklyGoal(mg *WFMonthlyGoal, title string, week int) error
- func (cl *Client) CreateCard(title string, board string, list string) (*trello.Card, error)
- func (cl *Client) GetCard(cardId string) (*trello.Card, error)
- func (cl *Client) GetMonthlyGoal(id string) (*WFMonthlyGoal, error)
- func (cl *Client) MonthlyGoals() (goals []WFMonthlyGoal, err error)
- func (cl *Client) MoveToListOnBoard(cardID string, listID, boardID string) (*trello.Card, error)
- func (cl *Client) SetDue(cardID string, due time.Time) (*WFTask, error)
- func (cl *Client) Tasks(board, boardList *string) (tasks []WFTask, err error)
- func (cl *Client) Test()
- type DayCards
- type DaySummary
- type MonthlyGoal
- type MonthlyGoalInfo
- type MonthlyGoalReview
- type MonthlyGoals
- type MonthlyRetrospective
- type MonthlyReview
- type MonthlySprintReview
- type MonthlySprints
- type MonthlySummary
- type PerGoalReview
- type PerGoalWeeklySummaryItems
- type TaskInfo
- type WFBoardList
- type WFMonthlyGoal
- type WFTask
- type WFWeeklyGoal
- type WeeklyGoalInfo
- type WeeklyReport
- type WeeklyRetrospective
- type WeeklyReview
- type WeeklyReviewData
- type WeeklySummary
- type WeeklySummaryItems
- type YearlySummary
Constants ¶
This section is empty.
Variables ¶
var ( AllLists = []BoardAndList{ {"Kanban daily/weekly", "Today"}, {"Kanban daily/weekly", "Waiting on"}, {"Kanban daily/weekly", "Done this week"}, {"Backlog (Personal)", "Backlog"}, {"Backlog (Personal)", "Projects"}, {"Backlog (work)", "Backlog"}, {"Periodic board", "Often"}, {"Periodic board", "Weekly"}, {"Periodic board", "Bi-weekly to monthly"}, {"Periodic board", "Quarterly to Yearly"}, } AllBoards = []Board{ {"Kanban daily/weekly"}, {"Backlog (Personal)"}, {"Periodic board"}, {"Someday/Maybe"}, {"Movies, TV"}, } )
Functions ¶
func BoardFor ¶
BoardFor finds trello board for board string with caching -- candidate for pushing into library
func CreateEmptyMonthlyRetrospective ¶
CreateEmptyMonthlyRetrospective populates an empty template based on monthly summary
func CreateEmptyWeeklyRetrospective ¶
CreateEmptyWeeklyRetrospective populates an empty template based on weekly summary
func DailyMaintenance ¶
DailyMaintenance moves cards in kanban board back to their homes at the end of the day
func DumpSummaryForWeek ¶
DumpSummaryForWeek dumps current content of Trello board to summary file for week
func DumpSummaryForWeekFromHistory ¶
DumpSummaryForWeekFromHistory dumps current content of Trello history board to summary file for week
func GenerateSummaryForMonth ¶
func GenerateSummaryForMonth(user, appkey, authtoken string, year, month int, summaryIn [][]byte, reviewIn []WeeklyReviewData, out io.Writer) error
GenerateSummaryForMonth rolls up weekly summaries to month level
func GenerateSummaryForYear ¶
GenerateSummaryForYear rolls up monthly summaries to year level
func GetTitleAndAttributes ¶
func ListFor ¶
ListFor finds trello list for board and list with caching -- candidate for pushing into library
func MinutelyMaintenance ¶
MinutelyMaintenance does things like cherry picking, moving, adding dates to titles
func MonthlyCleanup ¶
MonthlyCleanup moves cards to history board
func MorningRemind ¶
MorningRemind generates and sends an email reminding of weekly goals, daily todos, overdue cards
func VisualizeMonthlyRetrospective ¶
VisualizeMonthlyRetrospective writes out report of monthly goals, sprints
func VisualizeWeeklyRetrospective ¶
VisualizeWeeklyRetrospective writes out report of weekly tasks done, goals, sprints
func VisualizeWeeklySummariesForMonthly ¶
VisualizeMonthlyInput writes out report of weekly review items collated for preparing monthly review
func VisualizeYearlyPlanSummary ¶
VisualizeYearlyPlanSummary writes out report of monthly goals, sprints over the year
func WeeklyCleanup ¶
WeeklyCleanup moves cards to history board, copies periodic cards to history, moves periodic cards back
Types ¶
type BoardAndList ¶
func BoardListFor ¶
func BoardListFor(cl *Client, idBoard, idList string) (*BoardAndList, error)
BoardListFor returns board list for trello IDBoard and IDList
func ListForID ¶
func ListForID(ID string) *BoardAndList
ListForID returns board and list info for a particular list ID
type Client ¶
Client wraps logged in member
func (*Client) AddComment ¶
AddComment adds comment to card
func (*Client) AddMonthlyGoal ¶
func (*Client) AddWeeklyGoal ¶
func (cl *Client) AddWeeklyGoal(mg *WFMonthlyGoal, title string, week int) error
func (*Client) CreateCard ¶
func (*Client) GetMonthlyGoal ¶
func (cl *Client) GetMonthlyGoal(id string) (*WFMonthlyGoal, error)
func (*Client) MonthlyGoals ¶
func (cl *Client) MonthlyGoals() (goals []WFMonthlyGoal, err error)
MonthlyGoals returns all goals for this month
func (*Client) MoveToListOnBoard ¶
MoveToListOnBoard moves card to board/list
type DaySummary ¶
DaySummary is generated from WeeklySummary.Done
type MonthlyGoal ¶
type MonthlyGoalInfo ¶
type MonthlyGoalInfo struct { Title string `yaml:"title"` Created string `yaml:"createdDate"` WeeklyGoals []WeeklyGoalInfo `yaml:"weeklyGoals"` }
MonthlyGoalInfo defines what a monthly goal looks like - a title, when it was created and a list of weekly goals.
type MonthlyGoalReview ¶
type MonthlyGoals ¶
type MonthlyGoals struct { Month string Goals []MonthlyGoal }
type MonthlyRetrospective ¶
type MonthlyRetrospective struct { MonthlySummary // mostly source MonthlyReview // populated, joined with source }
MonthlyRetrospective defines what goes into the visualization template.
type MonthlyReview ¶
type MonthlyReview struct { Highlights []string `yaml:"highlights"` Continue []string `yaml:"continue"` DoDifferently []string `yaml:"doDifferently"` MonthlyGoalReviews []MonthlyGoalReview `yaml:"monthlyGoalReviews"` MonthlySprintReviews []MonthlySprintReview `yaml:"monthlySprintReviews"` CandidateGoals []string `yaml:"candidateGoals"` CandidateSprints []string `yaml:"candidateSprints"` }
MonthlyReview defines the manually input data that goes into the monthly review visualization
type MonthlySprintReview ¶
type MonthlySprints ¶
type MonthlySummary ¶
type MonthlySummary struct { Year int `yaml:"year"` Month int `yaml:"month"` WeeksOfYear string `yaml:"weeksOfYear"` MonthlyGoals []MonthlyGoalInfo `yaml:"monthlyGoals"` MonthlySprints []MonthlyGoalInfo `yaml:"monthlySprints"` Events []string `yaml:"events"` GoingWell []WeeklySummaryItems `yaml:"goingWell"` NeedsImprovement []WeeklySummaryItems `yaml:"needsImprovement"` Successes []WeeklySummaryItems `yaml:"successes"` Challenges []WeeklySummaryItems `yaml:"challenges"` MonthlyGoalSummaries []PerGoalWeeklySummaryItems `yaml:"monthlyGoalSummaries"` }
MonthlySummary defines the summarization data that is dumped for downstream consumption independent of task management tool (in this case Trello).
for monthly summary, monthly goal and monthly sprint info will merge together weekly goals
type PerGoalReview ¶
type PerGoalWeeklySummaryItems ¶
type PerGoalWeeklySummaryItems struct { Goal string `yaml:"goal"` DidToCreateOutcome []WeeklySummaryItems `yaml:"didToCreateOutcome"` KeepDoing []WeeklySummaryItems `yaml:"keepDoing"` DoDifferently []WeeklySummaryItems `yaml:"doDifferently"` }
PerGoalWeeklySummaryItems is array of feedback from a particular week for a particular goal
type TaskInfo ¶
type TaskInfo struct { CreatedDate string `yaml:"createdDate"` DoneDate string `yaml:"doneDate"` Title string `yaml:"title"` }
TaskInfo defines what a task looks like -- just reflects what's currenty in trello.
type WFBoardList ¶
type WFMonthlyGoal ¶
type WFMonthlyGoal struct { IDCard string Title string // `json:"title"` // contains filtered or unexported fields }
WFMonthlyGoal is a wrapper for underlying trello card representation
type WFTask ¶
type WFTask struct { ID string `json:"id"` Title string `json:"title"` Desc string `json:"desc"` CreatedDate *time.Time `json:"createdDate"` URL *string `json:"url"` Due *time.Time `json:"due"` List *WFBoardList `json:"list"` Period *string `json:"period"` DateLastActivity *time.Time `json:"dateLastActivity"` ChecklistItems []string `json:"checklistItems"` }
WFTask wraps underlying trello card representation
type WFWeeklyGoal ¶
type WFWeeklyGoal struct { IDCard string `json:"idCard"` IDCheckitem string `json:"idCheckitem"` Title string `json:"title"` Year *int `json:"year"` Month *int `json:"month"` Week *int `json:"week"` Done *bool `json:"done"` Status *string `json:"status"` }
WFWeeklyGoal is a wrapper for underlying trello card checklist item
func WeeklyGoals ¶
func WeeklyGoals(mg *WFMonthlyGoal) []WFWeeklyGoal
WeeklyGoals returns WFWeeklyGoals for a given monthly goal
type WeeklyGoalInfo ¶
type WeeklyGoalInfo struct { Title string `yaml:"title"` Created string `yaml:"createdDate"` Status string `yaml:"status"` Week int `yaml:"weekNumber"` Year int `yaml:"year"` }
WeeklyGoalInfo defines what a weekly goal looks like
type WeeklyReport ¶
type WeeklyReport struct { Week string DoneByDay []DayCards MonthlyGoalsByMonth []MonthlyGoals LatestMonthlySprints MonthlySprints LatestMonthGoals MonthlyGoals NowHHMM string }
type WeeklyRetrospective ¶
type WeeklyRetrospective struct { WeeklySummary WeeklyReview NowHHMM string ThisWeekSunday string DoneByDay []DaySummary }
WeeklyRetrospective defines what goes into the visualization template.
type WeeklyReview ¶
type WeeklyReview struct { GoingWell []string `yaml:"goingWell"` NeedsImprovement []string `yaml:"needsImprovement"` Successes []string `yaml:"successes"` Challenges []string `yaml:"challenges"` LearnAboutMyself []string `yaml:"learnAboutMyself"` LearnAboutOthers []string `yaml:"learnAboutOthers"` PerGoalReviews []PerGoalReview `yaml:"perGoalReviews"` }
WeeklyReview defines the manually input data that goes into weekly review visualization
type WeeklyReviewData ¶
WeeklyReviewData holds raw review content and extra info about the year, month, week it is from
type WeeklySummary ¶
type WeeklySummary struct { Year int `yaml:"year"` Month int `yaml:"month"` Week int `yaml:"weekNumber"` Done []TaskInfo `yaml:"doneThisWeek"` MonthlyGoals []MonthlyGoalInfo `yaml:"monthlyGoals"` MonthlySprints []MonthlyGoalInfo `yaml:"monthlySprints"` }
WeeklySummary defines the summarization data that is dumped for downstream consumption independent of task management tool (in this case Trello).
func GetSummaryForWeek ¶
func GetSummaryForWeek(user, appkey, authtoken string, year, week int) (*WeeklySummary, error)
GetSummaryForWeek returns a summary structure usable by other downstream in-memory pipelines like daily reminder.
func MorningRemindHtml ¶
func MorningRemindHtml(user, appkey, authtoken string) (*WeeklySummary, string, error)
MorningRemindHtml generates HTML for inspection as well as use in email
type WeeklySummaryItems ¶
WeeklySummaryItems is array of feedback from a particular week
type YearlySummary ¶
type YearlySummary struct { Year int `yaml:"year"` MonthlySummaries []MonthlySummary `yaml:"monthlySummaries"` }
YearlySummary defines what's dumped for rolling up into the yearly plan summary