Package: workalendar
WorkalendarOverviewWorkalendar is a Python module that offers classes able to handle calendars, list legal / religious holidays and gives working-day-related computation functions.InstallationWith pippipinstallworkalendarWith condacondainstall-cconda-forgeworkalendarExtra dependenciesNote: NEW in v16.0.0If the calendar(s) you want to work with requires astronomical computations (such as Asian calendars needing equinoxes or solar terms), Workalendar will provide pre-computed values within the year range from 1991 to 2051.However, if you want to use astronomical libraries to compute the calendar yourself, you'll need to install the[astronomy]extra dependency like this:pipinstallworkalendar[astronomy]If you had previously installed theskyfieldandskyfield-datapackages, they'll be used to compute the calendars. If you want to benefit from the "astronomical cache", and eventually benefit from performance gains, you'll have touninstallthose packages first to fallback to pre-computed files.StatusThis 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 theContributing doc.Usage sample>>>fromdatetimeimportdate>>>fromworkalendar.europeimportFrance>>>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 ChristmasFalse>>>cal.is_working_day(date(2012,12,30))# it's SundayFalse>>>cal.is_working_day(date(2012,12,26))True>>>cal.add_working_days(date(2012,12,23),5)# 5 working days after Xmasdatetime.date(2012,12,31)For a more complete documentation and advanced usage, go tothe official workalendar documentation.External dependenciesWorkalendar will require you to use Python 3.7+.Workalendar is tested on Python 3.7, 3.8, 3.9, 3.10, 3.11, and on Linux (Ubuntu), Mac OS and Windows using Github actions.Conditional dependenciesAs of v15.0.0:If you're using *Nix and Python 3.7, 3.8, the packagebackports.zoneinfois requiredIf you're using Windows and Python 3.7, 3.8, the packagetzdataisalsoa requirement (with thebackports.zoneinfo).If you're using Python 3.9+, the stdlibzoneinfopackage will be used.TestsCI status:To run test, just install tox withpip install toxand run:toxfrom the command line.Available CalendarsEuropeAustriaBelarusBelgiumBulgariaCayman IslandsCroatiaCyprusCzech RepublicDenmarkEstoniaEuropean Central BankFinlandFranceFrance (Alsace / Moselle)GeorgiaGermanyGreeceGuernseyHungaryIcelandIrelandItalyLatviaLithuaniaLuxembourgMaltaMonacoNetherlands (optionally with school holidays and carnival)NorwayPolandPortugalRomaniaRussiaSerbiaSlovakiaSloveniaSpain (Andalusia, Aragon, Castile and León, Castilla-La Mancha, Canary Islands, Extremadura, Galicia, Balearic Islands, La Rioja, Community of Madrid, Murcia, Navarre, Asturias, Basque Country, Cantabria, Valencian Community)SwedenSwitzerland (Aargau, Appenzell Innerrhoden, Appenzell Ausserrhoden, Bern, Basel-Landschaft, Basel-Stadt, Fribourg, Geneva, Glarus, Graubünden, Jura, Luzern, Neuchâtel, Nidwalden, Obwalden, St. Gallen, Schaffhausen, Solothurn, Schwyz, Thurgau, Ticino, Uri, Vaud, Valais, Zug, Zurich)TurkeyUkraineUnited Kingdom (incl. Northern Ireland, Scotland and all its territories)AmericaArgentinaBarbadosBrazil (all states, cities and for bank transactions, except the city of Viana)Canada (including provincial and territory holidays)ChileColombiaEl SalvadorMexicoPanamaParaguayUnited States of AmericaState holidays for all the 50 StatesAmerican SamoaChicago, IllinoisGuamSuffolk County, MassachusettsCalifornia Education, Berkeley, San Francisco, West HollywoodFlorida Legal and Florida Circuit Courts, Miami-DadeFederal Reserve SystemAsiaChinaHong KongIsraelJapanJapanBankKazakhstanMalaysiaPhilippinesQatarSingaporeSouth KoreaTaiwanOceaniaAustralia (incl. its different states)Marshall IslandsNew ZealandAfricaAlgeriaAngolaBeninIvory CoastKenyaMadagascarMozambiqueNigeriaSão ToméSouth AfricaTunisiaAnd more to come (I hope!)CaveatsPlease 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.Some countries have some holidays based on ephemerids and equinoxes. Those are computed for the previous and next 30 years to prevent big computations and dependencies.ContributingPlease read ourcontributing.mddocument to discover how you can contribute toworkalendar. Pull-requests are very welcome.HistoryThis project was born in 2013, as an answer to the question "how do we calculatethis date + 5 working days?". It was a use-case forPeopleDoc, in their ticketing application, for calculating SLAs. And it began as a small open-source library, for France and the USA at first.Thanks to PeopleDoc, this project grew and eventually became a world-wide library, with the help of dozens of contributors.As of June 2021, this project has moved to its own organization.LicenseThis library is published under the terms of the MIT License. Please check the LICENSE file for more details.