Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmsunmin/canada-holiday
a Python package for Canadian holidays.
https://github.com/kmsunmin/canada-holiday
canada canada-holiday holidays pypi python
Last synced: 27 days ago
JSON representation
a Python package for Canadian holidays.
- Host: GitHub
- URL: https://github.com/kmsunmin/canada-holiday
- Owner: kmsunmin
- License: mit
- Created: 2022-07-19T23:57:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T03:16:15.000Z (about 1 month ago)
- Last Synced: 2024-12-10T03:24:59.978Z (about 1 month ago)
- Topics: canada, canada-holiday, holidays, pypi, python
- Language: Python
- Homepage: https://pypi.org/project/canada-holiday/
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# canada-holiday
a Python package for retrieving Canadian holidays information for all provinces for any given year.
## Installation
### With pip:
```bash
pip install canada-holiday
```
### With poetry:
```bash
poetry add canada-holiday
```
## Usage
```python
import datetime
import canada_holiday
on_holidays_2023 = canada_holiday.get_holidays("Ontario", 2023)
# prints "Getting holiday information of Ontario province..."
print(on_holidays_2023)
# [CanadaHoliday(New Year's Day, 2023-01-01, Sunday, all), CanadaHoliday(Family Day, 2023-02-20, Monday, Ontario), ...]
manitoba_holidays_2023_june = canada_holiday.get_holidays("MB", 2023, 2)
# prints "Getting holiday information of Manitoba province..."
print(manitoba_holidays_2023_june)
# [CanadaHoliday(Louis Riel Day, 2023-02-20, Monday, Manitoba)]
louis_riel_day = manitoba_holidays_2023_june[0]
print(louis_riel_day.name)
# Louis Riel Day
print(louis_riel_day.month)
# 2
print(louis_riel_day.day)
# 20
print(louis_riel_day.date)
# 2023-02-20
print(louis_riel_day.province)
# Manitoba
print(louis_riel_day.day_of_the_week)
# Monday
date = datetime.date(2023, 8, 7)
result = canada_holiday.is_holiday(date, "British Columbia")
# prints "2023-08-07 is a holiday, B.C. Day in British Columbia province(s) in Canada"
print(result)
# True
date = datetime.date(2023, 4, 5)
result = canada_holiday.is_holiday(date, "Nova Scotia")
# prints "2023-04-05 is not a holiday in Nova Scotia province."
print(result)
# False
```