Facebook Birthday Events to ICS file converter
Around 20 June 2019, Facebook removed their Facebook Birthday ICS export option.
This change was unannounced and no reason was ever released.
fb2cal is a tool which restores this functionality.
It works by calling endpoints that power the https://www.facebook.com/events/birthdays/ page.
After gathering a list of birthdays for all the users friends for a full year, it creates a ICS calendar file. This ICS file can then be imported into third party tools (such as Google Calendar or Apple Calendar).
- Facebook accounts secured with 2FA are currently not supported (see #9)
- During Facebook authentication, a security checkpoint may trigger that will force you to change your Facebook password.
- Facebook account
- Python 3.9
- pipenv
- Scheduler tool to automatically run script periodically (optional)
https://pypi.org/project/fb2cal/
- In an empty folder of your choice, set up pipenv environment
pipenv install
- Install
fb2cal
module:
pipenv run pip install fb2cal
- Download config/config-template.ini file and store it in
config/config.ini
. - Update the
config/config.ini
file and enter your Facebook email and password (no quotes). - Run the
fb2cal
module
pipenv run python -m fb2cal
- Check the output folder (
out
by default) for the createdbirthdays.ics
file
- Clone repo
git clone [email protected]:mobeigi/fb2cal.git
- Copy
config/config-template.ini
toconfig/config.ini
. - Update the
config/config.ini
file and enter your Facebook email and password (no quotes). - Set up pipenv environment
pipenv install
- Run the
fb2cal
module
pipenv run python -m fb2cal
- Check the output folder (
out
by default) for the createdbirthdays.ics
file
This tool can be configured by editing the config/config.ini
configuration file.
Section | Key | Valid Values | Description |
---|---|---|---|
AUTH | fb_email | Your Facebook login email | |
fb_password | Your Facebook login password | ||
FILESYSTEM | save_to_file | True, False | If tool should save ICS file to the local file system |
ics_file_path | Path to save ICS file to (including file name) | ||
LOGGING | level | DEBUG, INFO, WARNING, ERROR, CRITICAL | Logging level to use. Default: INFO |
It is recommended to run the script once every 24 hours to update the ICS file to ensure it is synchronized with the latest Facebook changes (due to friend addition/removal) and to respect the privacy of users who decide to hide their birthday later on. Facebook originally recommended polling for birthday updates once every 12 hours based on the X-PUBLISHED-TTL:PT12H
header included in their ICS files.
- Set up pipenv environment
pipenv install
- Install the
fb2cal
module
pipenv run python -m pip install .
- Run the
unittests
module on thetests
folder
pipenv run python -m unittest discover tests
If you encounter any issues, please open the config/config.ini
configuration file and set the LOGGING
level
to DEBUG
(it is INFO
by default). Include these logs when asking for help.
Contributions are always welcome! Just make a pull request.
GNU General Public License v3.0