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 library is ready for production, although we may warn eventual users: some calendars may not be up-to-date, and this library doesn’t cover all the existing countries on earth (yet).

If you spot any bug or wish to add a calendar, please refer to the Contributing doc.

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/novafloss/workalendar.png

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

tox

from the command line.

Available Calendars

Europe

  • Austria

  • Belgium

  • Bulgaria

  • Croatia

  • Cyprus

  • Czech Republic

  • Denmark

  • Estonia

  • European Central Bank

  • Finland

  • France

  • France (Alsace / Moselle)

  • Germany

  • Greece

  • Hungary

  • Iceland

  • Ireland

  • Italy

  • Latvia

  • Luxembourg

  • Malta

  • Netherlands

  • Norway

  • Poland

  • Portugal

  • Romania

  • Slovakia

  • Sweden

  • United Kingdom (incl. Northern Ireland)

  • Spain (incl. Catalonia)

  • Slovenia

  • Switzerland * Vaud

America

  • Brazil (all states and cities, except the city of Viana)

  • Chile

  • Colombia

  • Mexico

  • Panama

  • United States of America (including state holidays)

  • Canada (including provincial and territory holidays)

Asia

  • Japan

  • Malaysia

  • Qatar

  • Singapore

  • 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-2.0.0.tar.gz (58.3 kB view details)

Uploaded Source

Built Distributions

workalendar-2.0.0-py3-none-any.whl (101.5 kB view details)

Uploaded Python 3

workalendar-2.0.0-py2-none-any.whl (116.5 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for workalendar-2.0.0.tar.gz
Algorithm Hash digest
SHA256 00e6b920ea3a23edce9eb649c57e02ea2a56528db92324ddf5e5e3dd3535b77a
MD5 70707e5160054ff9bda6550f82aeceb6
BLAKE2b-256 290d6c56a8e232c512c5538175b611b504c87d5bda5cec58ea06b43e9cb69220

See more details on using hashes here.

File details

Details for the file workalendar-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: workalendar-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 101.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for workalendar-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8efd76a5923eda72212c53ffe0aa4e681bdd47b42426f73fa4e4d65ee7f6a7d6
MD5 aaf7fa74bc05c8a51ebbf5da4dbd1011
BLAKE2b-256 fc101188df0936f6b039371f34c86f525d0b0e779d527d478483aa6e963c5370

See more details on using hashes here.

File details

Details for the file workalendar-2.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for workalendar-2.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 cb29ff54a8dfc5eca70108c530b0d7eb45cbda25c2c24e3e4582078fefb2b5c7
MD5 ef36e21cd41c9e018abc9a6a2e84a9cb
BLAKE2b-256 d4c7897c6e16c79bab19a8ac2e5305ed50ac9c176de01582612c285646ebf7d4

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