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.6.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.6-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: holiday_rlag-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 eb65a6ffc8a7354f2ab3965855f4afffe017ab24def247dba8e0d11efd9ea37d
MD5 0f66ca2053f1fffefe1a2e6f73065857
BLAKE2b-256 08fbc7c16f9fbe5b76f143f3372bf2f0edb1547252093acffc9a0f36435b9a92

See more details on using hashes here.

File details

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

File metadata

  • Download URL: holiday_rlag-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 4.7 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c3c48f0a8b58471bf6bc3aafac32f1ecfddb80128a750610908b069dc7ace212
MD5 d7991695b184a6415fc922def53e6e1d
BLAKE2b-256 abbff44b969ddca3b0810ab41ec24bc2eec4a1145d91f38253cc188bffae20c6

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