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.
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
Release history Release notifications | RSS feed
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 details)
Built Distribution
File details
Details for the file ozholiday-0.1.1.tar.gz
.
File metadata
- Download URL: ozholiday-0.1.1.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34df6b61070ad93f4227df4a488937208d34adae75793d0406220fc3d4492041 |
|
MD5 | 8366ed241ae1c33aeb687fd87216f5a6 |
|
BLAKE2b-256 | 319a43f3f98797166356e8bc52abc18947c4b5ce6c0cddea546720faad06614c |
File details
Details for the file ozholiday-0.1.1-py2.py3-none-any.whl
.
File metadata
- Download URL: ozholiday-0.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7345cba298634d2765f345f0f3b50bab2efa13d3df7c90837b1af5eb8eae2ea |
|
MD5 | 0dfc235a043dc489df22b6c5c7e37ad0 |
|
BLAKE2b-256 | 397237677061962ee50f0a91e51abee6bfd273e0c9e83f10c7d4d56f4e50a0f6 |