Skip to main content

Is it a public holiday?

Project description

python-publicholiday

Build Status Coverage Status PyPI version

A cli utility to help run things or not run things based on if it is a public holiday. The command exits 0 if today is a public holiday and exits 1 if not.

Installation: pip install publicholiday

Examples usage:

$ publicholiday --help
Usage: publicholiday [OPTIONS]

  Is it a public holiday?

Options:
  -c, --country TEXT  Supported country name or code.
  --help              Show this message and exit.

# Run a script on a public holiday
$ publicholiday && /thing/to/run.sh

# Run a script on all days that are not public holidays
$ publicholiday || /thing/to/run.sh

By default publicholiday will check against UK public holidays. You can change this by passing a supported country:

# Run a script on a Argentinian public holiday
$ publicholiday -c Argentina && /thing/to/run.sh

# Run a script on all days that are not US public holidays
$ publicholiday -c US || /thing/to/run.sh

This utility uses the holidays pip package, to find out if your country is supported see: https://pypi.org/project/holidays/

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

publicholiday-0.1.8.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

publicholiday-0.1.8-py2.py3-none-any.whl (2.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file publicholiday-0.1.8.tar.gz.

File metadata

File hashes

Hashes for publicholiday-0.1.8.tar.gz
Algorithm Hash digest
SHA256 5fb7eb14885a384f58a6ea1481a3c54636253c78d09167cb42e0eed1d5224c15
MD5 8c6327d96e4d3729b8f6bbad403c0f30
BLAKE2b-256 2b8e11041b446bc38eb86a05f292789519ca85a6479977a318d4d1deb4fae59e

See more details on using hashes here.

File details

Details for the file publicholiday-0.1.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for publicholiday-0.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5bebd73978dcc61916999b1f7b6e4141f5841eddbd6953eaaddf2f7ce30b1d68
MD5 20a7ce932f1bb6b76b164c41218b5975
BLAKE2b-256 6ae3a9d1046f6a26b90ddc19e8bb4f98f46f55bc9c677ced624c78e302e4ac17

See more details on using hashes here.

Supported by

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