https://github.com/escalate/google-contacts-birthday-ical-calendar

This commandline tool converts birthday events of an CSV export of Google Contacts via Google Takeout into a iCal calendar file.
https://github.com/escalate/google-contacts-birthday-ical-calendar

birthday contacts-birthday google google-birthday-notifier google-calendar google-contacts google-takeout ical icalendar notifications

Last synced: 2 months ago
JSON representation

This commandline tool converts birthday events of an CSV export of Google Contacts via Google Takeout into a iCal calendar file.

• Host: GitHub
• URL: https://github.com/escalate/google-contacts-birthday-ical-calendar
• Owner: escalate
• License: mit
• Created: 2021-09-04T11:16:00.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-25T18:18:28.000Z (2 months ago)
• Last Synced: 2024-11-25T19:26:39.212Z (2 months ago)
• Topics: birthday, contacts-birthday, google, google-birthday-notifier, google-calendar, google-contacts, google-takeout, ical, icalendar, notifications
• Language: Python
• Homepage:
• Size: 119 KB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Test](https://github.com/escalate/google-contacts-birthday-ical-calendar/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/escalate/google-contacts-birthday-ical-calendar/actions/workflows/test.yml)

# Google Contacts birthday to iCal calendar converter

This commandline tool converts birthday events of an CSV export of [Google Contacts](https://contacts.google.com/) via [Google Takeout](https://takeout.google.com/) into a iCal calendar file.

The iCal calendar file can then be imported into [Google Calendar](https://calendar.google.com/) to create notifications for birthdays of your contacts.

## Usage

Build Docker image

```

$ make build-docker-image

```

Run Docker container from built image to print help

```

$ make run-docker-image

Usage: converter.py [OPTIONS] CSVFILE ICALFILE

  Commandline interface for Google Contacts birthday to iCal calendar

  converter

  CSVFILE is the input .csv filepath.

  ICALFILE is the output .ics filepath.

Options:

  --verbose  Enable verbose logging output.

  --help     Show this message and exit.

```

Run Docker container from built image with custom arguments

```

$ docker compose \

    --file docker-compose.yml \

    run \

    --rm \

    --volume=$(pwd):/data:rw \

    google_contacts_birthday_ical_calendar \

    example.csv \

    example.ics \

    --verbose

```

## Development

Build and launch the [DevContainer](https://code.visualstudio.com/docs/devcontainers/containers) in [VSCode](https://code.visualstudio.com/).

## Other projects

* Google Apps Script which sends emails for birthdays of Google contacts [GoogleContactsEventsNotifier](https://github.com/GioBonvi/GoogleContactsEventsNotifier)

## Contribute

Please note the separate [contributing guide](https://github.com/escalate/google-contacts-birthday-ical-calendar/blob/master/CONTRIBUTING.md).

## License

MIT