From 411217d97b32cf1ca8c7d4e8a22cc157fa7a6b78 Mon Sep 17 00:00:00 2001 From: Pyry Lahtinen Date: Sun, 11 Dec 2022 14:43:22 +0000 Subject: [PATCH] improved readme --- README.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 98db5b1..0217339 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,11 @@ Python package for international fixed calendar dates. ## What is that? -International fixed calendar is an alternative calendar system. It divides year into 13 even months by adding a month called Sol between June and July. Each month starts with Sunday and has exactly 28 days or 4 weeks. An additional _year day_ is added to the end of the year and it does not belong to any of the months and has no weekday. You can read more about IFC on [Wikipedia](https://en.wikipedia.org/wiki/International_Fixed_Calendar). +International fixed calendar is an alternative calendar system. +It divides year into 13 even months by adding a month called Sol between June and July. +Each month starts with Sunday and has exactly 28 days or 4 weeks. +An additional _year day_ is added to the end of the year and it does not belong to any of the months and has no weekday. +You can read more about IFC on [Wikipedia](https://en.wikipedia.org/wiki/International_Fixed_Calendar). ## Usage @@ -18,8 +22,8 @@ fixed_date = FixedDate.today() # From native datetime from datetime import datetime -feburary_seventh = datetime(2022, 2, 7) -fixed_date = FixedDate(feburary_seventh) +february_seventh = datetime(2022, 2, 7) +fixed_date = FixedDate(february_seventh) # From day's ordinal in year fixed_date = FixedDate(day_of_year=107, year=2022) @@ -32,17 +36,16 @@ from fixedcal import FixedDate from datetime import datetime fixed_date = FixedDate(datetime(2022, 8, 12)) -fixed_date.datetime # datetime(2022, 8, 12, 0, 0, 0) -fixed_date.day_of_year # 224 -fixed_date.day_of_month # 28 -fixed_date.month # 8 -fixed_date.year # 2022 -fixed_date.is_year_day # False -fixed_date.week_of_month # 4 -fixed_date.weekday # 7 -fixed_date.week_of_year # 32 -fixed_date.year_quarter # 3 - +fixed_date.datetime # datetime(2022, 8, 12, 0, 0, 0) +fixed_date.day_of_year # 224 +fixed_date.day_of_month # 28 +fixed_date.month # 8 +fixed_date.year # 2022 +fixed_date.is_year_day # False +fixed_date.week_of_month # 4 +fixed_date.weekday # 7 +fixed_date.week_of_year # 32 +fixed_date.year_quarter # 3 ``` ### Date's operations @@ -53,18 +56,19 @@ from datetime import datetime, timedelta fixed_date = FixedDate(datetime(2022, 12, 6)) jan_first = FixedDate(datetime(2023, 1, 1)) -new_fixed = fixed_date + timedelta(3) # FixedDate 3 days ahead -new_fixed = fixed_date - timedelta(2) # FixedDate 2 days before -new_fixed = jan_first - fixed_date # timedelta between dates +new_fixed = fixed_date + timedelta(3) # FixedDate 3 days ahead +new_fixed = fixed_date - timedelta(2) # FixedDate 2 days before +new_fixed = jan_first - fixed_date # timedelta between dates -fixed_date == fixed_date # True -fixed_date != jan_first # True -jan_first < fixed_date # False +fixed_date == fixed_date # True +fixed_date != jan_first # True +jan_first < fixed_date # False ``` ### Year day -Year day is the day after the last of December and before the first of January. For that date, `FixedDate` gives the following property values. +Year day is the day after the last of December and before the first of January. +For that date, `FixedDate` gives the following property values. * `day_of_year` = 365 * `day_of_month` = 1