https://github.com/xyproto/kitchencalendar

:calendar: Generate per-week calendars that are meant to be printed out and hung up in the kitchen area
https://github.com/xyproto/kitchencalendar

calendar kitchen management pdf

Last synced: about 1 year ago
JSON representation

:calendar: Generate per-week calendars that are meant to be printed out and hung up in the kitchen area

• Host: GitHub
• URL: https://github.com/xyproto/kitchencalendar
• Owner: xyproto
• License: bsd-3-clause
• Created: 2023-02-11T11:03:56.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T19:37:54.000Z (about 2 years ago)
• Last Synced: 2024-05-22T19:44:50.902Z (about 2 years ago)
• Topics: calendar, kitchen, management, pdf
• Language: Go
• Homepage:
• Size: 854 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Kitchen Calendar

![Build](https://github.com/xyproto/kitchencalendar/workflows/Build/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/xyproto/kitchencalendar)](https://goreportcard.com/report/github.com/xyproto/kitchencalendar) [![License](https://img.shields.io/badge/license-BSD-green.svg?style=flat)](https://raw.githubusercontent.com/xyproto/kitchencalendar/main/LICENSE)

Kitchen Calendar is a utility written in Go that can generate PDF files.

Each generated PDF document is a calendar for two specific weeks, for example week 7 and 8.

This type of calendar can work great for a family of 4, a couple of co-workers or people that live together and need to find a good way to collaborate.

**By printing out and hanging up the calendars on the kitchen cupboard doors, there are no excuses for not having a good overview of what is happening in the weeks ahead, nor for what has been done or completed.**

**Known bug**: The week number on the calendar is wrong for 2025, since week 1 of 2025 starts at the end of 2024, and I didn't think of that. To be fixed soon.

I recommend printing out at least 6 pages, which covers 12 weeks, and hang them all up. It does occupy quite a bit of "visual space" in the kitchen, but it's immensely handy and practical.

The reason why I wrote this utility is because we use it in my family, and it works better for us than Google Calendar or other apps or web pages. The information is readily available without anyone having to "do anything" to see it, and one can easily add entries while making tea or coffee.

In addition to this, "red dates" (holidays / flag flying dates) are written in bold text in the calendar. The functionality for detecting "red days" comes from the [kal](https://github.com/xyproto/kal) package (this feature needs more testing).

Currently, only US and Norwegian calendars can be generated, but pull requests for supporting other locales are welcome!

The line art images comes from the excellent [ln](https://github.com/fogleman/ln) package.

### Example calendar (English, for the US)

![US kitchen calendar](img/us_kitchen_calendar.png)

Note that the 4th of July is in bold.

### Example calendar (Norwegian)

![Norwegian kitchen calendar](img/no_kitchen_calendar.png)

Note that the 17th of May is in bold.

### Installation

Go 1.17 or later is needed for `go install` to work as expected.

Install the US kitchen calendar generator:

    go install -tags en_US github.com/xyproto/kitchencalendar@latest

Install the Norwegian kitchen calendar generator:

    go install -tags nb_NO github.com/xyproto/kitchencalendar@latest

### Usage

The utility takes a list of comma separated names that will be used in the weekly overviews.

For creating a `calendar_w8_2023.pdf` file:

    kitchencalendar -names Bob,Alice,Mallory,Judy -year 2023 -week 8

For generating calendars for week 7 to 17 (with 2 weeks on each PDF), for this year

    for x in $(seq 7 2 17); do kitchencalendar -names Bob,Alice,Mallory,Judy -week $x; done

### General info

* Version: 1.0.5

* License: BSD-3

* Author: Alexander F. Rødseth