Metadata-Version: 2.1
Name: date-offset
Version: 0.0.3
Summary: An library to allow offset of dates by a string
Home-page: https://github.com/django-advance-utils/date-offset
Author: Tom Turner
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

Date-offset
===========
.. image:: https://badge.fury.io/py/date-offset.svg
    :target: http://badge.fury.io/py/date-offset


.. image:: https://codecov.io/gh/django-advance-utils/date-offset/branch/main/graph/badge.svg?token=QPGW5TIGX3
    :target: https://codecov.io/gh/django-advance-utils/date-offset
    
This allow you to offset date / time with a string.

Example

.. code-block::

    d = DateOffset()
    tomorrow = d.get_offset("1d")
    yesterday = d.get_offset("-1d")



Keyword
-------

* # start of week (Monday)
* \* end of week
* % first day of the month
* d offset by days (1d)
* w offset by weeks (1w)
* m offset by months (1m)
* y offset by years (1y)
* ~ not weekend
* s offset by seconds (3600s)
* i offset by minutes (60m)
* h offset by hours (1h)
* t time (10t = 10hr. 10:15t = 10hr 15mins. 10:15:45t = 10hr 15mins 45secs)


Usage
-----

If you want to include time in your output the `include_time` must be set.

.. code-block::

    d = DateOffset()
    one_hours_time = d.get_offset("1h", include_time=True)


Nested string can be used

.. code-block::

    d = DateOffset()
    second_day_of_current_month = d.get_offset("%1d")



