Skip to content

Repository files navigation

Test

Google Contacts birthday to iCal calendar converter

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

The iCal calendar file can then be imported into Google Calendar to create notifications for birthdays of your contacts.

📚 Usage

  1. Build the Docker image.
$ make build-docker-image
  1. Run Docker container from built image to print help.
$ make run-docker-image

Usage: cli.py [OPTIONS] CSVFILE ICALFILE

  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.
  1. 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

🧩 Similar Projects

If you’re interested in similar or related projects, check out:

🤝 Contributing

We welcome contributions of all kinds 🎉.

Please read our Contributing guide to learn how to get started, submit changes, and follow our contribution standards.

🌐 Code of Conduct

This project follows a Code of Conduct to ensure a welcoming and respectful community.

By participating, you agree to uphold this standard.

🐛 Issues

Found a bug or want to request a feature?

Open an issue here: GitHub Issues

🧪 Development

Development is possible via an interactive Docker container in VSCode.

  1. Build and launch the DevContainer in VSCode.

  2. Initiate the Python Virtual Environment via poetry env activate in the terminal.

  3. Run test suite via pytest in the terminal.

📜 License

This project is licensed under the MIT License.

See the LICENSE file for details.

About

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

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages