Metadata-Version: 1.1
Name: workingless
Version: 0.2.1
Summary: Holidays and working days calculations
Home-page: https://github.com/pity7736/workingless
Author: Julián Cortés
Author-email: pity7736@gmail.com
License: UNKNOWN
Description: ===========
        Workingless
        ===========
        .. image:: https://readthedocs.org/projects/workingless/badge/?version=latest
            :target: https://workingless.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://circleci.com/gh/pity7736/workingless.svg?style=shield
            :target: https://circleci.com/gh/pity7736/workingless
        
        
        
        Workingless is a lib for holidays calculations. Currently it supports Colombia
        and Mexico (beta) holidays.
        
        
        `See full documentation <https://workingless.readthedocs.io/en/latest/?badge=latest>`_.
        
        
        Usage
        -----
        
        Workingless has four methods for the countries supported, they are:
        ``get_holidays_from_year``, ``is_holiday``, ``is_working_day`` and ``get_next_working_day``.
        
        Example usage:
        
        .. code-block:: python
        
            import datetime
        
            from workingless import countries
        
            colombia = countries.COL()
            holidays = colombia.get_holidays_from_year(year=2020)
            print(type(holidays))  # <class 'generator'>
            print(list(holidays))
            # result:
            # [
            #     datetime.date(2020, 1, 1),
            #     datetime.date(2020, 1, 6),
            #     datetime.date(2020, 3, 23),
            #     datetime.date(2020, 4, 5),
            #     datetime.date(2020, 4, 9),
            #     datetime.date(2020, 4, 10),
            #     datetime.date(2020, 4, 12),
            #     datetime.date(2020, 5, 1),
            #     datetime.date(2020, 5, 25),
            #     datetime.date(2020, 6, 15),
            #     datetime.date(2020, 6, 22),
            #     datetime.date(2020, 6, 29),
            #     datetime.date(2020, 7, 20),
            #     datetime.date(2020, 8, 7),
            #     datetime.date(2020, 8, 17),
            #     datetime.date(2020, 10, 12),
            #     datetime.date(2020, 11, 2),
            #     datetime.date(2020, 11, 16),
            #     datetime.date(2020, 12, 8),
            #     datetime.date(2020, 12, 25)
            # ]
            colombia.is_holiday(date=datetime.date(2020, 1, 1))  # True
            colombia.is_working_day(datetime.date(2020, 1, 1)  # False
            colombia.get_next_working_day(datetime.date(2020, 1, 1)  # datetime.date(2020, 1, 2)
        
        License
        -------
        
        Distributed under the terms of the GPLv3 license.
        
        See `license <https://github.com/pity7736/workingless/blob/master/LICENSE>`_.
        
Keywords: holiday working-day
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
