Merge pull request #5 from dschenck/v0.0.13

V0.0.13

docs/index.rst

@@ -1,6 +1,6 @@
 doubledate
 =====================================
-**doubledate** exposes a set of 20+ utility functions as well as an immutable :code:`Calendar` object representing a sorted-set of dates.
+**doubledate** exposes an immutable :code:`Calendar` object representing a sorted-set of dates as well as a suite of 20+ utility functions.
 
 .. include:: fragments/badges.rst
 
@@ -14,9 +14,65 @@ Installation
 Quickstart 
 -------------------------------------
 
-Using doubledate is also easy
+Using doubledate is also easy: simply wrap a list of dates in a :code:`doubledate.Calendar`
 ::
 
+    >>> import doubledate as dtwo
+    
+    >>> dates = [...] # list of dates
+    >>> calendar = dtwo.Calendar(dates)
+    <doubledate.calendar.Calendar at 0x17...>
+
+More realistically:
+
+::
+
+    >>> import datetime
+    >>> import doubledate as dtwo
+
+    # load from database, file...
+    >>> holidays = [
+    ...     datetime.date(2024,  1,  2),  # New Years Day
+    ...     datetime.date(2024,  1, 15),  # Martin Luther King, Jr. Day
+    ...     datetime.date(2024,  2, 19),  # Washington's Birthday
+    ...     datetime.date(2024,  3, 29),  # Good Friday
+    ...     datetime.date(2024,  5, 27),  # Memorial Day
+    ...     datetime.date(2024,  6, 19),  # Juneteenth National Independence Day
+    ...     datetime.date(2024,  7,  4),  # Independence Day
+    ...     datetime.date(2024,  9,  2),  # Labor day
+    ...     datetime.date(2024, 11, 28),  # Thanksgiving Day
+    ...     datetime.date(2024, 12, 25)   # Christmas day
+    ... ]
+
+    # create a Calendar
+    # here, every weekday (Mon-Fri), excluding holidys
+    >>> calendar = dtwo.Calendar.create(
+    ...     "B", 
+    ...     starting=dtwo.date(2024, 1, 1), 
+    ...     ending=dtwo.date(2024, 12, 31)
+    ... ).difference(holidays)
+
+    # first business day each month
+    >>> calendar.resample("M").first()
+    <doubledate.calendar.Calendar at 0x17...>
+
+    # last business day each week ending on Wednesday 
+    >>> calendar.resample("W-WED").nth(-1)
+    <doubledate.calendar.Calendar at 0x17...>
+
+    # first or last business day dependending on month
+    >>> calendar.resample("M").apply(
+    ...    lambda month: month[0] if month.start.month < 7 else month[-1]
+    ... ).combine()
+    <doubledate.calendar.Calendar at 0x17...>
+
+    # most recent date as of given date
+    >>> calendar.asof(datetime.date(2024, 9, 4), side="left")
+    datetime.date(2024, 8, 30)
+
+The library also comes with an additional suite of utility functions
+:: 
+
     >>> import datetime
     >>> import doubledate as dtwo
 

docs/source/Calendar/doubledate.Calendar.create.rst

@@ -0,0 +1,4 @@
+Calendar.create 
+============================================ 
+
+.. automethod:: doubledate.Calendar.create

docs/source/Calendar/doubledate.Calendar.rst

@@ -9,6 +9,7 @@ Calendar
 
    doubledate.Calendar.apply.rst
    doubledate.Calendar.asof.rst
+   doubledate.Calendar.create.rst
    doubledate.Calendar.dates.rst
    doubledate.Calendar.dayof.rst
    doubledate.Calendar.daysbetween.rst

doubledate/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.12"
+__version__ = "0.0.13"
 
 from datetime import MAXYEAR, MINYEAR
 from datetime import date, datetime, time, timedelta, timezone, tzinfo