Skip to main content

Worldwide holidays and working days helper and toolkit.

Project description

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 France
>>> cal = France()
>>> 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
>>> cal.add_working_days(date(2012, 12, 23), 5)  # 5 working days after Xmas
datetime.date(2012, 12, 31)

External dependencies

You may want to install python-dev and/or python3-dev on your machine to either run the installation or run tests via tox.

Tests

Travis status:

https://api.travis-ci.org/novapost/workalendar.png

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

tox

from the command line.

Available Calendars

Europe

  • Belgium

  • Czech Republic

  • European Central Bank

  • Finland

  • France

  • France (Alsace / Moselle)

  • Germany

  • Greece

  • Hungary

  • Iceland

  • Italy

  • Luxembourg

  • Netherlands

  • Norway

  • Poland

  • Portugal

  • Slovakia

  • Sweden

  • United Kingdom (incl. Northern Ireland)

  • Spain

America

  • Brazil (incl. São Paulo state and city)

  • Chile

  • Colombia

  • Mexico

  • Panama

  • United States of America (including state holidays)

  • Canada (including provincial and territory holidays)

Asia

  • Japan

  • Qatar

  • South Korea

  • Taiwan

Oceania

  • Australia (incl. its different states)

  • Marshall Islands

Africa

  • Algeria

  • Benin

  • Ivory Coast

  • Madagascar

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

Contributing

Please read our CONTRIBUTING.rst document to discover how you can contribute to workalendar. Pull-requests are very welcome.

License

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

workalendar-0.4.2.tar.gz (20.0 kB view details)

Uploaded Source

File details

Details for the file workalendar-0.4.2.tar.gz.

File metadata

  • Download URL: workalendar-0.4.2.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for workalendar-0.4.2.tar.gz
Algorithm Hash digest
SHA256 5b914771d915842f8b560a77796ef5bfd6af3d3fa31b3154bc57a8e7b7f74197
MD5 64e3fcb9ebcbd978bb289c650e8a9c1c
BLAKE2b-256 eb492282c32bb243b83fb5fd2244805d209ffb81f5a906f840b7bfe9b55e9645

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page