Skip to main content

A simple function to check if a given date a public holiday in Australia

Project description

# OZ Holiday

A simple function to check a given date a public holiday or not in Australia, really easy to use.

- Use the data from [data.gov.au](https://data.gov.au/dataset/australian-holidays-machine-readable-dataset)
- Only use Python standard libraries
- Only one function - keep it simple

## Installation
```bash
pip install ozholiday
```

Or

```bash
git clone https://github.com/zhongdai/ozholiday.git
cd ozholiday
python setup.py install
```

## Usage
```python
In [1]: from ozholiday import isholiday

In [2]: isholiday('20170101')
Out[2]: True

In [3]: isholiday('20170101',detail=True)
Out[3]:
{'Applicable To': 'NAT',
'Date': '20170101',
'Holiday Name': "New Year's Day",
'Information': "New Year's Day is the first day of the calendar year and is celebrated each January 1st",
'More Information': '',
'_id': 1}

In [5]: isholiday('20170103')
Out[5]: False

In [9]: isholiday('20190102')
ValueError: The date 20190102 is not in current list published by data.gov.au,
Check here https://data.gov.au/dataset/australian-holidays-machine-readable-dataset
```


=======
History
=======

0.1.0 (2018-03-02)
------------------

* First release on PyPI.


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

ozholiday-0.1.1.tar.gz (9.1 kB view hashes)

Uploaded Source

Built Distribution

ozholiday-0.1.1-py2.py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 2 Python 3

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