Metadata-Version: 2.1
Name: fiscal-calendar-helper
Version: 0.0.7
Summary: A fiscal helper for retail calendars
Project-URL: Homepage, https://github.com/Growthsayer/fiscal-helper
Project-URL: Bug Tracker, https://github.com/Growthsayer/fiscal-helper/issues
Author: Phillip Geltman
License: MIT License
        
        Copyright (c) 2022 Growthsayer Incorporated
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.md
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Fiscal Calendar Helper

This helper function is based on the National Retail Federations 4-5-4 calendar for Python 3.

## Key features: 
- Offset a date or week
- Translate a date to the fiscal week and vice versa

To use the fiscal helper:
```
from fiscal_calendar_helper import fiscal 
```

## Fiscal Offsets
```
>>> fiscal.offset('2022_31', 4)
'2022_35'
```

## Fiscal next / previous
Returns the next or previous week or date
```
>>> fiscal.next('2022_31')
'2022_32'

>>> fiscal.previous('2022_31')
'2022_30'
```