# Holidata
`holidata` is a utility for algorithmically producing holiday data.
Its purpose is mainly for [holidata.net](https://holidata.net).
Holiday data can be produced for a given year in a supported locale and output format.
## Usage
```
holidata --year=<value> --locale=<value> [--output=<value>]
holidata --year=<value> --country=<value> [--lang=<value>] [--output=<value>]
```
Call `holidata` with the `--help` option to more detailed information.
### Examples
* Create holiday data of year `2022` for locale `de-DE`:
```
$ holidata --year=2022 --locale=de-DE
```
* Create holiday data of year `2022` for country `BE` and language `fr`:
```
$ holidata --year=2022 --country=BE --lang=fr
```
* Create holiday data of year `2022` for country `US` (default language `en`):
```
$ holidata --year=2022 --country=US
```
## Data
For each holiday the following data is provided:
* `locale` - language and country the holiday is defined for
* `region` - region code of the given subdivision the holiday is defined for
* `date` - actual date the holiday takes place
* `description` - name of the holiday in the given language
* `type` - holiday type flags
* `notes` - additional information
## Locales
Holidata provides holiday data in different locales, i.e. for a given country and in a given language.
See [holidata.net](https://holidata.net/locales/) for a complete overview of the currently provided locales.
If you think a locale is missing, [open a feature request on GitHub](https://github.com/GothenburgBitFactory/holidata/issues).
## Output Formats
Holidata supports different output formats, currently `csv`, `json`, `yaml`, and `xml`.
If you think an output format is missing, [open a feature request on GitHub](https://github.com/GothenburgBitFactory/holidata/issues).
## Limitations
Holidata focuses on holidays which are _defined by law on which business or work are suspended or reduced_ (there may be some exceptions to that rule).
Holidata only provides data for countries and their principal subdivisions (both as they are defined in ISO 3166).
Holidays for other subdivisions are either merged or ignored.
There is also no explicit representation of partial holidays.
## License
`holidata` is released under the MIT license.
For details check the [LICENSE](LICENSE) file.
Raw data
{
"_id": null,
"home_page": "https://github.com/GothenburgBitFactory/holidata",
"name": "holidata",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "holiday, calendar",
"author": "Gothenburg Bit Factory",
"author_email": "support@gothenburgbitfactory.org",
"download_url": "https://files.pythonhosted.org/packages/01/9f/136186b02dd639ad510a7732176b68a413876e8597e56bf7774253d05eeb/holidata-2024.11.1.tar.gz",
"platform": null,
"description": "# Holidata\n\n`holidata` is a utility for algorithmically producing holiday data.\nIts purpose is mainly for [holidata.net](https://holidata.net).\n\nHoliday data can be produced for a given year in a supported locale and output format.\n\n## Usage\n\n```\nholidata --year=<value> --locale=<value> [--output=<value>]\nholidata --year=<value> --country=<value> [--lang=<value>] [--output=<value>]\n```\nCall `holidata` with the `--help` option to more detailed information.\n\n### Examples\n* Create holiday data of year `2022` for locale `de-DE`:\n ```\n $ holidata --year=2022 --locale=de-DE\n ```\n \n* Create holiday data of year `2022` for country `BE` and language `fr`:\n ```\n $ holidata --year=2022 --country=BE --lang=fr\n ```\n \n* Create holiday data of year `2022` for country `US` (default language `en`):\n ```\n $ holidata --year=2022 --country=US\n ```\n\n## Data\n\nFor each holiday the following data is provided:\n* `locale` - language and country the holiday is defined for\n* `region` - region code of the given subdivision the holiday is defined for\n* `date` - actual date the holiday takes place\n* `description` - name of the holiday in the given language\n* `type` - holiday type flags\n* `notes` - additional information\n\n## Locales\n\nHolidata provides holiday data in different locales, i.e. for a given country and in a given language.\nSee [holidata.net](https://holidata.net/locales/) for a complete overview of the currently provided locales.\n\nIf you think a locale is missing, [open a feature request on GitHub](https://github.com/GothenburgBitFactory/holidata/issues).\n\n## Output Formats\n\nHolidata supports different output formats, currently `csv`, `json`, `yaml`, and `xml`.\n\nIf you think an output format is missing, [open a feature request on GitHub](https://github.com/GothenburgBitFactory/holidata/issues).\n\n## Limitations\n\nHolidata focuses on holidays which are _defined by law on which business or work are suspended or reduced_ (there may be some exceptions to that rule).\n\nHolidata only provides data for countries and their principal subdivisions (both as they are defined in ISO 3166).\nHolidays for other subdivisions are either merged or ignored.\nThere is also no explicit representation of partial holidays.\n\n## License\n\n`holidata` is released under the MIT license.\nFor details check the [LICENSE](LICENSE) file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Holidata is a utility for algorithmically producing holidays for a given locale and year",
"version": "2024.11.1",
"project_urls": {
"Bug Reports": "https://github.com/GothenburgBitFactory/holidata/issues",
"Homepage": "https://github.com/GothenburgBitFactory/holidata",
"Source": "https://github.com/GothenburgBitFactory/holidata",
"Website": "https://holidata.net"
},
"split_keywords": [
"holiday",
" calendar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ded259bce23292a8884bbd8a77f04dc5f92fddec6c88ce5c4d9895f4f98f288d",
"md5": "afe0150492ee874b1221c90acebbc61e",
"sha256": "56972f393d39b4b94afb0d1c3aaa749d07970f611264dacb44759e723d18ec3f"
},
"downloads": -1,
"filename": "holidata-2024.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afe0150492ee874b1221c90acebbc61e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 71404,
"upload_time": "2024-11-14T17:43:31",
"upload_time_iso_8601": "2024-11-14T17:43:31.274862Z",
"url": "https://files.pythonhosted.org/packages/de/d2/59bce23292a8884bbd8a77f04dc5f92fddec6c88ce5c4d9895f4f98f288d/holidata-2024.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "019f136186b02dd639ad510a7732176b68a413876e8597e56bf7774253d05eeb",
"md5": "bba40e923706fd7dc1eea480a78e4163",
"sha256": "630ce4cb6c615e065386e4985a52308eb714edd0e86f77275a9c398afc233846"
},
"downloads": -1,
"filename": "holidata-2024.11.1.tar.gz",
"has_sig": false,
"md5_digest": "bba40e923706fd7dc1eea480a78e4163",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 38907,
"upload_time": "2024-11-14T17:43:33",
"upload_time_iso_8601": "2024-11-14T17:43:33.354895Z",
"url": "https://files.pythonhosted.org/packages/01/9f/136186b02dd639ad510a7732176b68a413876e8597e56bf7774253d05eeb/holidata-2024.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 17:43:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GothenburgBitFactory",
"github_project": "holidata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "holidata"
}
JSON
