Skip to content

wllzhang/BirthdayRS

Repository files navigation

Birthday Reminder System

Docker Image Python Version CI License

A powerful birthday reminder system supporting both lunar and solar calendars with rich Chinese cultural information.

中文文档 | Documentation

Features

  • Dual Calendar Support - Solar (Gregorian) & Lunar (Chinese) birthdays
  • Rich Date Information - GanZhi, zodiac, festivals, solar terms, constellations
  • Multiple Notifications - Email & ServerChan
  • Flexible Deployment - Local, Docker, GitHub Actions

Quick Start

# Install
pip install -r requirements.txt

# Configure
cp config.example.yml config.yml
# Edit config.yml with your settings

# Run
python -m src.main run --config config.yml

Documentation

Full documentation is available at https://wllzhang.github.io/BirthdayRS/

Docker

docker run -v ${PWD}/config.yml:/app/config.yml ghcr.io/wllzhang/birthdayrs:latest run

License

MIT License

About

Birthday Reminder System

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors