Metadata-Version: 2.5
Name: cli-calendar
Version: 1.0.0
Summary: CLI Calendar with multiple styles to display the current month on your terminal
Project-URL: Homepage, https://github.com/lluises/cli_calendar
Project-URL: Issues, https://github.com/lluises/cli_calendar/issues
Author-email: LluísE <code@kitsune.cat>
License-File: LICENSE
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# CLI Calendar

CLI Calendar with multiple styles to display the current month on your terminal.

NOTE: Monday is always the first day of the week. Currently this is not configurable, if you are interested in this option being tweakable with a parameter, open an issue and I will take a look at it.

```
┌─────────────────────────────────────────┐
│ 8  August                          2026 │
├─────┬─────┬─────┬─────┬─────┬─────┬─────┤
│ Mon │ Tue │ Wed │ Thu │ Fri │ Sat │ Sun │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│  27 │  28 │  29 │  30 │  31 │  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 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│  31 │  1  │  2  │  3  │  4  │  5  │  6  │
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘
```

- **Author**: [LluisE](https://github.com/lluises)
- **Website**: https://kitsune.cat
- **Source**: https://github.com/lluises/cli_calendar
- **Licence**: https://www.mozilla.org/en-US/MPL/2.0/


# Installation

This project is available in PyPI: https://pypi.org/project/cli-calendar

You can install it in your machine by just doing:

```
pip install cli-calendar
```


# Usage

After installation, just run `calendar` on your shell.

Double check your `PATH` in case the command is not found. Sometimes pip might install it under `$HOME/.local/bin/` and if you don't have it your `$PATH` you will need to either add it or create an alias like `alias calendar=$HOME/.local/bin/calendar`


```
usage: calendar.py [-h] [-d DAY] [-m MONTH] [-y YEAR] [-a] [-l LOOK] [-nc]
                   [--lang LANG] [--lang-days LANG_DAYS]
                   [--lang-months LANG_MONTHS] [-c]

CLI Calendar for the terminal by LluisE

options:
  -h, --help            show this help message and exit
  -d, --day DAY         Calendar day: 27
  -m, --month MONTH     Calendar month: 07 or May
  -y, --year YEAR       Calendar year: 2019
  -a, --all             Print all the calendars of the year
  -l, --look LOOK       Change how the calendar looks: 0, 1 or 2
  -nc, --no-color       Disable colored output
  --lang LANG           Language: en, es, ca, jp
  --lang-days LANG_DAYS
                        Language for days
  --lang-months LANG_MONTHS
                        Language for months
  -c, --compact         Compact calendar width
```

# Styles

**Style 0**

```
                                           
  8  August                          2026  
                                           
  Mon   Tue   Wed   Thu   Fri   Sat   Sun  
                                           
   27    28    29    30    31    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  
                                           
   31    1     2     3     4     5     6   
                                           
```

**Style 1**

```
|-----------------------------------------|
| 8  August                          2026 |
|-----------------------------------------|
| Mon | Tue | Wed | Thu | Fri | Sat | Sun |
|-----+-----+-----+-----+-----+-----+-----|
|  27 |  28 |  29 |  30 |  31 |  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 |
|-----+-----+-----+-----+-----+-----+-----|
|  31 |  1  |  2  |  3  |  4  |  5  |  6  |
|-----------------------------------------|

```

**Style 2**

```
┌─────────────────────────────────────────┐
│ 8  August                          2026 │
├─────┬─────┬─────┬─────┬─────┬─────┬─────┤
│ Mon │ Tue │ Wed │ Thu │ Fri │ Sat │ Sun │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│  27 │  28 │  29 │  30 │  31 │  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 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│  31 │  1  │  2  │  3  │  4  │  5  │  6  │
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘
```

**Style 3**

```
···········································
: 8  August                          2026 :
···········································
: Mon : Tue : Wed : Thu : Fri : Sat : Sun :
···········································
:  27 :  28 :  29 :  30 :  31 :  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 :
···········································
:  31 :  1  :  2  :  3  :  4  :  5  :  6  :
···········································
```

All the styles can be compacted with the `-c` or `--compact` flag:

```
┌───────────────────────────┐
│ 8  August            2026 │
├───┬───┬───┬───┬───┬───┬───┤
│Mon│Tue│Wed│Thu│Fri│Sat│Sun│
├───┼───┼───┼───┼───┼───┼───┤
│ 27│ 28│ 29│ 30│ 31│ 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│
├───┼───┼───┼───┼───┼───┼───┤
│ 31│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │
└───┴───┴───┴───┴───┴───┴───┘
```


# LICENSE

This project is licenced under the Mozilla Public License version 2.0. You may obtain a copy of the licence at the [LICENCE file in this repository](./LICENSE), or online at [https://www.mozilla.org/en-US/MPL/2.0/](https://www.mozilla.org/en-US/MPL/2.0/).
