Skip to main content

Welcome to Nager Public Holiday API’s documentation!

Build Testing Build Coverage Read the Docs GitHub release (latest by date) PyPI Downloads GitHub commits since latest release (by date) for a branch GitHub Sponsor

Overview

Unofficial Python bindings for the Nager Public Holiday API. The goal is to make interaction with the API as easy as possible.

Installation & Documentation

pip install nagerapi

Documentation can be found at Read the Docs.

Connecting to Nager

Getting a NagerObjectAPI Instance

To connect to the Nager Public Holiday API you use the ~nagerapi.NagerObjectAPI object.

from nagerapi import NagerObjectAPI

nager = NagerObjectAPI()
import nagerapi

nager = nagerapi.NagerObjectAPI()

Usage Examples

Example: List all 2022 US Holidays.

In this one we get the US ~nagerapi.Country Object and call public_holidays from that object.

from nagerapi import NagerObjectAPI

nager = NagerObjectAPI()
country = nager.country("US")

for holiday in country.public_holidays(2022):
    print(f"{holiday.name} is on {holiday.date.strftime('%Y-%m-%d')}")

Alternatively you can call public_holidays from the ~nagerapi.NagerObjectAPI object directly providing the country code.

from nagerapi import NagerObjectAPI

nager = NagerObjectAPI()

for holiday in nager.public_holidays(2022, "US"):
    print(f"{holiday.name} is on {holiday.date.strftime('%Y-%m-%d')}")

Usage & Contributions

  • Source is available on the Github Project Page.

  • Contributors to NagerAPI own their own contributions and may distribute that code under the MIT license.

Release files for nagerapi 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nagerapi 0.3.1
File Size Uploaded
nagerapi-0.3.1.tar.gz 7.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nagerapi 0.3.1
File Interpreter ABI Platform
nagerapi-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 14.4 kB

Release files / nagerapi-0.3.1.tar.gz

Download URL nagerapi-0.3.1.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
71a50e39df221c2e7778276df48073bff99185fd70e5092cea64015aa502be04
BLAKE2b-256 checksum
How to use checksums
438459d1a5892f0d2e512ebbe971635fd7bfb43098d504d9cbbba617fd44bcac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.1

Release files / nagerapi-0.3.1-py3-none-any.whl

Download URL nagerapi-0.3.1-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0a1518a52cde15f43969ce605496355103e3bbad56bceea335c445b5e9a5e2ee
BLAKE2b-256 checksum
How to use checksums
278b7febf08093ae07e653df9b11f553f9997120753567436a3a9ed5dcec5926
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.1

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.2.0

2 release files

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page