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

This version

1.3.0

Download files

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

Source Distribution

workalendar-1.3.0.tar.gz (48.1 kB view details)

Uploaded Source

Built Distributions

workalendar-1.3.0-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

workalendar-1.3.0-py2-none-any.whl (78.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for workalendar-1.3.0.tar.gz
Algorithm Hash digest
SHA256 fefa6bdf24367280a62e8fdc46dd0dd92994ea16773ee6fad50152b730cdd430
MD5 acbc10808f039dd9f467b639bfe60839
BLAKE2b-256 2cdde1a99fbf4eb776484c42c0673c0879e8bba90641c88bf87e1553986b07e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: workalendar-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 69.7 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-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa878df4159b004bb8e0c976e90406585e94ef25637f4a399d12a8fbd8fc1a84
MD5 fae3605ce2ffac26a47a45f1f74b8c74
BLAKE2b-256 c00bb74414721e6eec34c3bc961df2892f573a5fe47bd36ec1d2516ba8164b22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for workalendar-1.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 852828249422b8f1720ace7c0a391861130233cf01ebddd79da4ff00ab345493
MD5 9b1d9f1c777d335217c619404f615af8
BLAKE2b-256 80703ed2c810ae12d7f36c3175db4b4b2d60601adaff70a9765426ab266ff3ee

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