Metadata-Version: 2.1
Name: jalali-calendar-cli
Version: 0.1.3
Summary: Jalali (Shamsi) calendar in your terminal, with holidays
Author: NightMachinery
Author-email: feraidoonmehri@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: jdatetime (>=4.1.1,<5.0.0)
Description-Content-Type: text/plain

#+TITLE: jalali-calendar-cli

Jalali (Shamsi) calendar in your terminal, with holidays

* Install
#+begin_example bash
pip install -U jalali-calendar-cli
#+end_example

* Usage
#+ATTR_HTML: :width 884
[[file:readme.org_imgs/20230524_003016_h5V1Xf.png]]
#+ATTR_HTML: :width 968
[[file:readme.org_imgs/20230606_103928_zRAerD.png]]

#+begin_example bash
usage: jalali-calendar [-h] [--color {auto,always,never}]
                       [--true-color | --no-true-color]
                       [--footnotes | --no-footnotes]
                       [--indentation INDENTATION]
                       [--holidays-json-path HOLIDAYS_JSON_PATH]
                       [--color-preset COLOR_PRESET]
                       [--weekend-true-color WEEKEND_TRUE_COLOR]
                       [--holiday-true-color HOLIDAY_TRUE_COLOR]
                       [--header-true-color HEADER_TRUE_COLOR]
                       [--weekend-color WEEKEND_COLOR]
                       [--holiday-color HOLIDAY_COLOR]
                       [--header-color HEADER_COLOR]
                       [month] [year]

positional arguments:
  month                 month in Jalali calendar (default: current month)
  year                  year in Jalali calendar (default: current year)

options:
  -h, --help            show this help message and exit
  --color {auto,always,never}
                        colorize the output
  --true-color, --no-true-color
                        enable true color support for output (default: False)
  --footnotes, --no-footnotes
                        show footnotes in the output (default: True)
  --indentation INDENTATION
                        number of spaces for indentation (default: 5)
  --holidays-json-path HOLIDAYS_JSON_PATH
                        path to JSON file containing holiday data
  --color-preset COLOR_PRESET
                        color preset for the calendar output (default: light)

24-bit True Color Options:
  --weekend-true-color WEEKEND_TRUE_COLOR
                        RGB values for weekend color in 24-bit True Color
  --holiday-true-color HOLIDAY_TRUE_COLOR
                        RGB values for holiday color in 24-bit True Color
  --header-true-color HEADER_TRUE_COLOR
                        RGB values for header color in 24-bit True Color

Colorama 256 Color Options:
  --weekend-color WEEKEND_COLOR
                        Colorama color name for weekend color
  --holiday-color HOLIDAY_COLOR
                        Colorama color name for holiday color
  --header-color HEADER_COLOR
                        Colorama color name for header color
#+end_example

#+begin_example bash
jcal 12
#+end_example

#+begin_example
            1402 Esfand           
 Sat  Sun  Mon  Tue  Wed  Thu  Fri
                  1    2    3    4
   5    6    7    8    9   10   11
  12   13   14   15   16   17   18
  19   20   21   22   23   24   25
  26   27   28   29

 Holidays:
    6: Birthday of Imam Mahdi
   29: Nationalization of the Oil Industry
#+end_example

#+begin_example bash
jcal 7 1402
#+end_example

#+begin_example
             1402 Mehr            
 Sat  Sun  Mon  Tue  Wed  Thu  Fri
   1    2    3    4    5    6    7
   8    9   10   11   12   13   14
  15   16   17   18   19   20   21
  22   23   24   25   26   27   28
  29   30

 Holidays:
    2: Martyrdom of Imam Hassan Askari and Start of Imamate of Imam Mahdi
   11: Birthday of Prophet Muhammad and Imam Sadiq
#+end_example

* Holidays Data
The default data dictionary is [[https://github.com/NightMachinery/jalali-calendar-cli/blob/master/jalali_calendar_cli/holidays.json][here]]. I plan to keep the data up-to-date for the upcoming years, but you can always supply your own.

The holiday data of previous years (≤1401) has not been added.

