Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.17 KB

README.en.md

File metadata and controls

63 lines (46 loc) · 2.17 KB

Chinese Calendar

Package Travis License README

Check if some date is workday or holiday in China. Support 2004 ~ 2024.

Installation

pip install chinesecalendar

Upgrade

pip install -U chinesecalendar

Chinese government announces holiday arrangement usually during November. This project will release new version after official announcement.

Sample

import datetime

# Check if 2018-04-30 is holiday in China
from chinese_calendar import is_holiday, is_workday
april_last = datetime.date(2018, 4, 30)
assert is_workday(april_last) is False
assert is_holiday(april_last) is True

# or check and get the holiday name
import chinese_calendar as calendar  # 也可以这样 import
on_holiday, holiday_name = calendar.get_holiday_detail(april_last)
assert on_holiday is True
assert holiday_name == calendar.Holiday.labour_day.value

# even check if a holiday is in lieu
import chinese_calendar
assert chinese_calendar.is_in_lieu(datetime.date(2006, 2, 1)) is False
assert chinese_calendar.is_in_lieu(datetime.date(2006, 2, 2)) is True

Other Languages

If you fail to use Python directly, you can translate the constants file to get the complete chinese holiday arrangement.

Contributing

  1. Fork & Clone this project
  2. Modify calendar definition file
  3. Run script to generate the constants file
  4. Create a PR