Skip to main content

Fetches holiday information from https://github.com/vacanza/holidays and applies reverse lagging (that is, future indicators) for time series training.

Project description

holiday-rlag

Fetches holiday information using the holidays library and applies reverse lagging (future indicators) for time series training.

Features

  • Fetches holidays for a given date range and country
  • Adds reverse lagged indicators for holidays (e.g., is a holiday coming up in the next N days?)
  • Flags for Easter, Christmas, and bank holidays

Installation

pip install holiday-rlag
# or, if using uv:
uv pip install .

Requirements

Usage

from holiday_rlag.laggedholidays import fetch_holidays
import datetime

date_start = datetime.date(2023, 1, 1)
date_end = datetime.date(2023, 12, 31)
holidays = fetch_holidays(date_start, date_end, country_code="DE", reverse_lag=7)

API

fetch_holidays(...)

Fetches holidays for a given date range and country, with optional reverse lagging.

Parameters:

  • date_start (datetime.date): Start date
  • date_end (datetime.date): End date
  • country_code (str): Country code (default: "DE")
  • reverse_lag (int): Number of days to look back for reverse lagging (default: 7)
  • col_is_easter, col_is_christmas, col_is_bank_holiday: Column names for flags
  • col_lag_prefix, col_lag_suffix: Prefix/suffix for lagged columns

Returns:

  • list[dict]: List of dictionaries with holiday and lagged indicator flags

Note: The result is not a complete date list. Fill all dates you need and apply fillna(0) if converting to a DataFrame.

Example Output

[
	{
		"date": "2023-04-09",
		"is_easter": 1,
		"is_christmas": 0,
		"is_bank_holiday": 1,
		"is_easter_in_next_1_days": 1,
		...
	},
	...
]

License

MIT License. See LICENSE file.

Project details


Download files

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

Source Distribution

holiday_rlag-0.1.7.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

holiday_rlag-0.1.7-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file holiday_rlag-0.1.7.tar.gz.

File metadata

  • Download URL: holiday_rlag-0.1.7.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for holiday_rlag-0.1.7.tar.gz
Algorithm Hash digest
SHA256 4c2aff00d87f47be4030372cf41dc4d995facd3b6e8f902c59ebfdf1852032b5
MD5 abd4b06913e9468f7e2aefd0f38398c6
BLAKE2b-256 6ff26ff8c8cde944029566af72bbf0856e0fbf574ad78e805a19acb1c94d364c

See more details on using hashes here.

File details

Details for the file holiday_rlag-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: holiday_rlag-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for holiday_rlag-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c5812a3a161a554ed95bb9354a9f62d3374ac0ae580b853fe76f43696f5f8f9e
MD5 6771658c9f76a46e070bb8cc3106be39
BLAKE2b-256 4a12a00710ff48463e8192d837bbb4ab7075929eb2c86148698c90f2e593052e

See more details on using hashes here.

Supported by

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