https://github.com/azuyalabs/yasumi
The easy PHP Library for calculating holidays
https://github.com/azuyalabs/yasumi
api calculate-holidays calculating-holidays calculations countries holiday holidays library php provider-holidays yasumi
Last synced: about 1 month ago
JSON representation
The easy PHP Library for calculating holidays
- Host: GitHub
- URL: https://github.com/azuyalabs/yasumi
- Owner: azuyalabs
- License: mit
- Created: 2015-03-24T12:28:50.000Z (about 10 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-08T14:38:54.000Z (about 2 months ago)
- Last Synced: 2025-04-08T23:14:56.413Z (about 2 months ago)
- Topics: api, calculate-holidays, calculating-holidays, calculations, countries, holiday, holidays, library, php, provider-holidays, yasumi
- Language: PHP
- Homepage: https://www.yasumi.dev
- Size: 21.2 MB
- Stars: 1,059
- Watchers: 14
- Forks: 158
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-php - Yasumi - A library to help you calculate the dates and names of holidays. (Table of Contents / Date and Time)
- awesome-php-cn - Yasumi - 一个库来帮助你计算假期的日期和名称. (目录 / 日期和时间 Date and Time)
- awesome-projects - Yasumi - An library to help you calculate the dates and names of holidays. (PHP / Date and Time)
- awesome-php - Yasumi - A library to help you calculate the dates and names of holidays. (Table of Contents / Date and Time)
README
[](https://github.com/azuyalabs/yasumi/releases)
[](https://packagist.org/packages/azuyalabs/yasumi)
[](LICENSE)
## New Documentation Site 🎉
Yasumi's [documentation site](https://www.yasumi.dev) just got a make-over! Please check out the
[announcement](https://github.com/azuyalabs/yasumi/discussions/358) or head straight to it.
## Introduction
Yasumi (Japanese for 'Holiday'「休み」) is the easy PHP library that helps you retrieve the dates and names of holidays and
other special celebrations from various countries/states. It is calculation and rule driven avoiding the need of a
comprehensive database.
Many services exist that can provide holiday information, however are either not entirely free or only offer limited
information. In addition, no exhaustive PHP library exists today covering a wide range of holidays and
countries. [PEAR's Date_Holidays](https://pear.php.net/package/Date_Holidays) library was a similar attempt, however it
hasn't been updated for a long time.
## Highlights
The goal of Yasumi is to be powerful while remaining lightweight, by utilizing PHP native classes wherever possible.
Yasumi's calculation is provider-based (i.e. by country/state), making it easy to add new holiday providers that
calculate holidays.
- Pure PHP with a straightforward API
- Framework-agnostic
- Use of Providers to easily extend and expand new Holidays
- Common Holiday Providers
- Accounts for the date/time when holidays have been officially established and/or abolished
- Filters enabling to easily select certain holiday types (Official, Observed, Bank, Seasonal or Other)
- Global Translations
- Time zone aware
- Implements [ArrayIterator](https://www.php.net/manual/en/class.arrayiterator.php) to easily process a provider's
holidays
- Fully [documented](https://www.yasumi.dev)
- Fully unit tested
- [Composer](https://getcomposer.org) ready, [PSR-12](https://www.php-fig.org/psr/psr-12/)
and [PSR-4](https://www.php-fig.org/psr/psr-4/) compliant
## Documentation
Yasumi’s documentation is available on [https://www.yasumi.dev](https://www.yasumi.dev). You will find all the necessary
information how to install Yasumi and also recipes how you can use Yasumi in your project.
## Contributing
Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on GitHub :)
Create [GitHub Issues](https://github.com/azuyalabs/yasumi/issues) for bugs and new features and comment on the ones you
are interested in.
If you enjoy what I am making, an extra cup of coffee is very much appreciated :). Your support helps me to put more
time into Open-Source Software projects like this.
## License
This project is open-sourced software licensed under the MIT License (MIT). Please see [LICENSE](LICENSE) for more information.