holidays

Generate and work with holidays in Python

These details have not been verified by PyPI

Project links

Homepage

Project description

A fast, efficient Python library for generating country- and subdivision- (e.g. state or province) specific sets of government-designated holidays on the fly. It aims to make determining whether a specific date is a holiday as fast and flexible as possible.

Package:
CD/CI:
Docs:
Meta:

Install

The latest stable version can always be installed or updated via pip:

$ pip install --upgrade holidays

Documentation

The documentation is hosted on Read the Docs.

Quick Start

from datetime import date
import holidays

us_holidays = holidays.US()  # this is a dict
# the below is the same, but takes a string:
us_holidays = holidays.country_holidays('US')  # this is a dict

nyse_holidays = holidays.NYSE()  # this is a dict
# the below is the same, but takes a string:
nyse_holidays = holidays.financial_holidays('NYSE')  # this is a dict

date(2015, 1, 1) in us_holidays  # True
date(2015, 1, 2) in us_holidays  # False
us_holidays.get('2014-01-01')  # "New Year's Day"

The HolidayBase dict-like class will also recognize date strings and Unix timestamps:

'2014-01-01' in us_holidays  # True
'1/1/2014' in us_holidays    # True
1388597445 in us_holidays    # True

Some holidays may be only present in parts of a country:

us_pr_holidays = holidays.country_holidays('US', subdiv='PR')
'2018-01-06' in us_holidays     # False
'2018-01-06' in us_pr_holidays  # True

Please see the python-holidays documentation for additional examples and detailed information.

Available Countries

We currently support 121 country codes. The standard way to refer to a country is by using its ISO 3166-1 alpha-2 code, the same used for domain names, and for a subdivision its ISO 3166-2 code. The following countries and subdivisions are available:

Country	Code	Subdivisions Available
Albania	AL	None
American Samoa	AS	None; Can also be loaded as country US, subdivision AS
Andorra	AD	Parishes: 02, 03, 04, 05, 06, 07, 08
Angola	AO	None
Argentina	AR	None
Armenia	AM	None
Aruba	AW	None
Australia	AU	States and territories: ACT (default), NSW, NT, QLD, SA, TAS, VIC, WA
Austria	AT	States: 1, 2, 3, 4, 5, 6, 7, 8, 9 (default)
Azerbaijan	AZ	None
Bahrain	BH	None
Bangladesh	BD	None
Belarus	BY	None
Belgium	BE	None
Bolivia	BO	Departments: B, C, H, L, N, O, P, S, T
Bosnia and Herzegovina	BA	Departments: BD, FBiH, RS
Botswana	BW	None
Brazil	BR	States: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO
Bulgaria	BG	None
Burundi	BI	None
Canada	CA	Provinces and territories: AB, BC, MB, NB, NL, NS, NT, NU, ON (default), PE, QC, SK, YT
Chile	CL	Regions: AI, AN, AP, AR, AT, BI, CO, LI, LL, LR, MA, ML, NB, RM, TA, VS
China	CN	None
Colombia	CO	None
Costa Rica	CR	None
Croatia	HR	None
Cuba	CU	None
Curacao	CW	None
Cyprus	CY	None
Czechia	CZ	None
Denmark	DK	None
Djibouti	DJ	None
Dominican Republic	DO	None
Ecuador	EC	None
Egypt	EG	None
Estonia	EE	None
Eswatini	SZ	None
Ethiopia	ET	None
Finland	FI	None
France	FR	Départements: Alsace-Moselle, Guadeloupe, Guyane, La Réunion, Martinique, Mayotte, Métropole, Nouvelle-Calédonie, Polynésie Française, Saint-Barthélémy, Saint-Martin, Wallis-et-Futuna
Georgia	GE	None
Germany	DE	States: BB, BE, BW, BY, BYP, HB, HE, HH, MV, NI, NW, RP, SH, SL, SN, ST, TH
Greece	GR	None
Guam	GU	None; Can also be loaded as country US, subdivision GU
Honduras	HN	None
Hong Kong	HK	None
Hungary	HU	None
Iceland	IS	None
India	IN	States: AN, AP, AR, AS, BR, CG, CH, DD, DH, DL, GA, GJ, HP, HR, JH, JK, KA, KL, LA, LD, MH, ML, MN, MP, MZ, NL, OR, PB, PY, RJ, SK, TN, TR, TS, UK, UP, WB
Indonesia	ID	None
Ireland	IE	None
Isle of Man	IM	None
Israel	IL	None
Italy	IT	Provinces: AG, AL, AN, AO, AP, AQ, AR, AT, AV, BA, BG, BI, BL, BN, BO, BR, BS, BT, BZ, CA, CB, CE, CH, CL, CN, CO, CR, CS, CT, CZ, EN, FC, FE, FG, FI, FM, FR, GE, GO, GR, IM, IS, KR, LC, LE, LI, LO, LT, LU, MB, MC, ME, MI, MN, MO, MS, MT, NA, NO, NU, OR, PA, PC, PD, PE, PG, PI, PN, PO, PR, PT, PU, PV, PZ, RA, RC, RE, RG, RI, RM, RN, RO, SA, SI, SO, SP, SR, SS, SU, SV, TA, TE, TN, TO, TP, TR, TS, TV, UD, VA, VB, VC, VE, VI, VR, VT, VV. Cities: Andria, Barletta, Cesena, Forlì, Pesaro, Trani, Urbino
Jamaica	JM	None
Japan	JP	None
Kazakhstan	KZ	None
Kenya	KE	None
Kyrgyzstan	KG	None
Latvia	LV	None
Lesotho	LS	None
Liechtenstein	LI	None
Lithuania	LT	None
Luxembourg	LU	None
Madagascar	MG	None
Malawi	MW	None
Malaysia	MY	States: JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PJY, PLS, PNG, PRK, SBH, SGR, SWK, TRG
Malta	MT	None
Marshall Islands (the)	MH	None
Mexico	MX	None
Moldova	MD	None
Monaco	MC	None
Montenegro	ME	None
Morocco	MA	None
Mozambique	MZ	None
Namibia	NA	None
Netherlands	NL	None
New Zealand	NZ	Regions: AUK, CAN, CIT, HKB, MBH, NSN, NTL, OTA, STL, TKI, WGN, WTC. Sub-regions: South Canterbury
Nicaragua	NI	Departments: AN, AS, BO, CA, CI, CO, ES, GR, JI, LE, MD, MN (default), MS, MT, NS, RI, SJ
Nigeria	NG	None
Northern Mariana Islands (the)	MP	None; Can also be loaded as country US, subdivision MP
North Macedonia	MK	None
Norway	NO	None
Pakistan	PK	None
Panama	PA	None
Paraguay	PY	None
Peru	PE	None
Philippines	PH	None
Poland	PL	None
Portugal	PT	Districts: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 30, Ext; Use subdiv=’Ext’ to include holidays most people have off
Puerto Rico	PR	None; Can also be loaded as country US, subdivision PR
Romania	RO	None
Russia	RU	None
San Marino	SM	None
Saudi Arabia	SA	None
Serbia	RS	None
Singapore	SG	None
Slovakia	SK	None
Slovenia	SI	None
South Africa	ZA	None
South Korea	KR	None
Spain	ES	Autonomous communities: AN, AR, AS, CB, CE, CL, CM, CN, CT, EX, GA, IB, MC, MD, ML, NC, PV, RI, VC
Sweden	SE	None
Switzerland	CH	Cantons: AG, AR, AI, BL, BS, BE, FR, GE, GL, GR, JU, LU, NE, NW, OW, SG, SH, SZ, SO, TG, TI, UR, VD, VS, ZG, ZH
Taiwan	TW	None
Thailand	TH	None
Tunisia	TN	None
Turkey	TR	None
Ukraine	UA	None
United Arab Emirates	AE	None
United Kingdom	GB	Subdivisions: England, Northern Ireland, Scotland, UK (default), Wales; For Isle of Man use country code IM
United States Minor Outlying Islands	UM	None; Can also be loaded as country US, subdivision UM
United States of America (the)	US	States and territories: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
United States Virgin Islands (the)		See Virgin Islands (U.S.)
Uruguay	UY	None
Uzbekistan	UZ	None
Vatican City	VA	None
Venezuela	VE	None
Vietnam	VN	None
Virgin Islands (U.S.)	VI	None; Can also be loaded as country US, subdivision VI
Zambia	ZM	None
Zimbabwe	ZW	None

Available Financial Markets

The standard way to refer to a financial market is to use its ISO 10383 MIC (Market Identifier Code) as a “country” code when available. The following financial markets are available:

Entity	Code	Info
European Central Bank	ECB	Trans-European Automated Real-time Gross Settlement (TARGET2)
New York Stock Exchange	XNYS	NYSE market holidays (used by all other US-exchanges, including NASDAQ, etc.)

Localization

Some of the supported entities (country/market) provide more than one language for holiday names output. The default language is defined by default_language (optional) attribute for each entity and is used as a fallback when neither user specified language nor user locale language available. The default language code is a ISO 639-1 code.

Country	Default Language	Supported languages
Argentina	es	en_US, es, uk
Armenia	hy	en_US, hy
Austria	de	de, en_US, uk
Belarus	be	be, en_US
Bulgaria	bg	bg, en_US
Canada	en	en, fr, th
Chile	es	en_US, es, uk
Colombia	es	en_US, es, uk
Costa Rica	es	en_US, es, uk
Cuba	es	en_US, es, uk
Cyprus	el	el, en
Denmark	da	da, en_US, uk
Dominican Republic	es	en_US, es, uk
Ecuador	es	en_US, es, uk
Ethiopia	am	am, en_US
Finland	fi	en_US, fi, sv, uk
France	fr	en_US, fr, uk
Georgia	ka	en_US, ka
Germany	de	de, en_US, uk
Greece	el	el, en_US
Honduras	es	en_US, es, uk
Iceland	is	en_US, is, uk
Japan	ja	en_US, ja
Liechtenstein	de	de, en_US, uk
Mexico	es	en_US, es, uk
Moldova	ro	en_US, ro, uk
Monaco	fr	en_US, fr, uk
Netherlands	nl	en_US, nl, uk
Nicaragua	es	en_US, es, uk
Norway	no	en_US, no, uk
Paraguay	es	en_US, es, uk
Peru	es	en_US, es, uk
Poland	pl	en_US, pl, uk
Portugal	pt_PT	en_US, pt_PT
Romania	ro	en_US, ro, uk
Russia	ru	en_US, ru
Serbia	sr	en_US, sr
Sweden	sv	en_US, sv, uk
Thailand	th	en_US, th
Ukraine	uk	en_US, uk
Uruguay	es	en_US, es, uk
Venezuela	es	en_US, es, uk

Beta Version

The latest development (beta) version can be installed directly from GitHub:

$ pip install --upgrade https://github.com/dr-prodigy/python-holidays/tarball/beta

All new features are always first pushed to beta branch, then released on master branch upon official version upgrades.

Contributions

Issues and pull requests are always welcome. Please see here for more information.

License

Code and documentation are available according to the MIT License (see LICENSE).

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

0.60

Nov 4, 2024

0.59

Oct 21, 2024

0.58

Oct 7, 2024

0.57

Sep 16, 2024

0.56

Sep 2, 2024

0.55

Aug 19, 2024

0.54

Aug 5, 2024

0.53

Jul 15, 2024

0.52

Jul 1, 2024

0.51

Jun 17, 2024

0.50

Jun 3, 2024

0.49

May 20, 2024

0.48

May 6, 2024

0.47

Apr 15, 2024

0.46

Apr 1, 2024

0.45

Mar 18, 2024

0.44

Mar 4, 2024

0.43

Feb 19, 2024

0.42

Feb 5, 2024

0.41

Jan 15, 2024

0.40

Jan 1, 2024

0.39

Dec 18, 2023

0.38

Dec 4, 2023

0.37

Nov 20, 2023

0.36

Nov 6, 2023

0.35

Oct 16, 2023

0.34

Oct 2, 2023

0.33

Sep 18, 2023

0.32

Sep 4, 2023

0.31

Aug 21, 2023

0.30

Aug 7, 2023

0.29

Jul 17, 2023

0.28

Jul 3, 2023

0.27.1

Jun 21, 2023

0.27

Jun 19, 2023

0.26

Jun 5, 2023

0.25

May 15, 2023

This version

0.24

May 1, 2023

0.23

Apr 17, 2023

0.22

Apr 3, 2023

0.21.13

Mar 15, 2023

0.21

Mar 6, 2023

0.20

Feb 23, 2023

0.19

Jan 30, 2023

0.18

Dec 27, 2022

0.17.2

Nov 23, 2022

0.17

Nov 13, 2022

0.16

Sep 16, 2022

0.15

Aug 21, 2022

0.14.2

Jun 5, 2022

0.13

Feb 15, 2022

0.12

Jan 4, 2022

0.11.3.1

Sep 29, 2021

0.11.2

Jul 18, 2021

0.11.1

Apr 2, 2021

0.10.5.2

Feb 4, 2021

0.10.4

Dec 6, 2020

0.10.3

Jul 15, 2020

0.10.2

Apr 13, 2020

0.10.1

Jan 26, 2020

0.9.12

Dec 23, 2019

0.9.11

Jul 28, 2019

0.9.10

Mar 12, 2019

0.9.9

Jan 3, 2019

0.9.8

Oct 18, 2018

0.9.7

Sep 12, 2018

0.9.6

Aug 1, 2018

0.9.5

Apr 23, 2018

0.9.4

Mar 12, 2018

0.9.3

Jan 19, 2018

0.9.1

Mar 12, 2018

0.8.1

Feb 12, 2017

0.8

Feb 3, 2017

0.7

Jan 12, 2017

0.6

Nov 18, 2016

0.5

Sep 5, 2016

0.4.1

Jan 5, 2016

0.4

Oct 4, 2015

0.3.1

Oct 9, 2014

0.3

Sep 4, 2014

0.2

Aug 28, 2014

0.1

Aug 28, 2014

Download files

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

Source Distribution

holidays-0.24.tar.gz (398.6 kB view details)

Uploaded May 1, 2023 Source

Built Distribution

holidays-0.24-py3-none-any.whl (499.9 kB view details)

Uploaded May 1, 2023 Python 3

File details

Details for the file holidays-0.24.tar.gz.

File metadata

Download URL: holidays-0.24.tar.gz
Upload date: May 1, 2023
Size: 398.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for holidays-0.24.tar.gz
Algorithm	Hash digest
SHA256	`484a1104b7a4248329d371d24dbae2289222c037194b4132c00d2076778936bd`
MD5	`998b451dd5ec948053c0f87d48dcbede`
BLAKE2b-256	`f0dec93fc72e2bb7b4ff471e44ad1bb091e16c91a5a1f9690f3c3524ba96d7b0`

See more details on using hashes here.

Provenance

File details

Details for the file holidays-0.24-py3-none-any.whl.

File metadata

Download URL: holidays-0.24-py3-none-any.whl
Upload date: May 1, 2023
Size: 499.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for holidays-0.24-py3-none-any.whl
Algorithm	Hash digest
SHA256	`7418c0ef1f5274849bc1e385e62f5a470b41839f8b45a798a087311b7966f03f`
MD5	`adac1854b499b54667471d3349477273`
BLAKE2b-256	`48df2b25d39d02d68537e8b34715cd01b499f8377c9ecef033bf1c09e59de771`