Workalendar

Overview

Workalendar is a Python module that offers classes able to handle calendars, list legal / religious holidays and gives working-day-related computation functions.

Status

This is barely beta. Please consider this module as a work in progres.

Usage sample

>>> from datetime import date
>>> from workalendar.europe import FranceCalendar
>>> cal = FranceCalendar()
>>> cal.holidays(2012)
[(datetime.date(2012, 1, 1), 'New year'),
 (datetime.date(2012, 4, 9), 'Easter Monday'),
 (datetime.date(2012, 5, 1), 'Labour Day'),
 (datetime.date(2012, 5, 8), 'Victory in Europe Day'),
 (datetime.date(2012, 5, 17), 'Ascension Day'),
 (datetime.date(2012, 5, 28), 'Whit Monday'),
 (datetime.date(2012, 7, 14), 'Bastille Day'),
 (datetime.date(2012, 8, 15), 'Assumption of Mary to Heaven'),
 (datetime.date(2012, 11, 1), "All Saints' Day"),
 (datetime.date(2012, 11, 11), 'Armistice Day'),
 (datetime.date(2012, 12, 25), 'Christmas')]
>>> cal.is_working_day(date(2012, 12, 25))  # it's Christmas
False
>>> cal.is_working_day(date(2012, 12, 30))  # it's Sunday
False
>>> cal.is_working_day(date(2012, 12, 26))
True

Tests

Travis status:

To run test, just install nose with pip install nose and run:

nosetests

from the command line.

Available Calendars

Europe

Czech Republic
France
France (Alsace / Moselle)
Hungary
Iceland
Italy
Norway
United Kingdom (incl. Northern Ireland)

America

Brazil (incl. São Paulo state and city)
Mexico
United States of America (only the federal state holidays at the moment)

Asia

Japan
Qatar
South Korea
Taiwan

Oceania

Australia (incl. its different states)

Africa

Algeria
Benin
Ivory Coast
São Tomé
South Africa

And more to come (I hope!)

Caveats

Please take note that some calendars are not 100% accurate. The most common example is the Islamic calendar, where some computed holidays are not exactly on the same official day decided by religious authorities, and this may vary country by country. Whenever it's possible, try to adjust your results with the official data provided by the adequate authorities.

License

This library is published under the terms of the MIT License. Please check the LICENSE file for more details.

pieqq / workalendar