Metadata-Version: 2.0
Name: nicecal
Version: 1.1.3
Summary: Create good looking plain text calendars using box-drawing characters.
Home-page: https://github.com/awesmubarak/nicecal
Author: Awes Mubarak
Author-email: awes.mubarak@awesmubarak.com
License: MIT
Keywords: nicecal calendar cal unicode
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python

=======
Nicecal
=======

Create simple calendars using box-drawing characters

Usage
=====

Month
-----

``nicecal.month(2038, 1)``
::

    ┌──────────────────────┐
    │        January       │
    │ Mo Tu We Th Fr Sa Su │
    │              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 │
    └──────────────────────┘

The calendar output can be modified using the following arguments:

Options:

- ``show_month_info`` (default 1)
    - 0: No month information header
    - 1: Only month name centred as header
    - 2: Both month name and year centred as header
- ``show_days`` (default 1)
    - 0: Day names are not shown
    - 1: Day names are shown

``>>>nicecal.month(2038, 1, show_month_info=0)``
::

    ┌──────────────────────┐
    │ Mo Tu We Th Fr Sa Su │
    │              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 │
    └──────────────────────┘

``>>>nicecal.month(2038, 1, show_month_info=2)``
::

    ┌──────────────────────┐
    │     January 2038     │
    │ Mo Tu We Th Fr Sa Su │
    │              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 │
    └──────────────────────┘


``>>>nicecal.month(2038, 1, show_days=0)``
::

    ┌──────────────────────┐
    │        January       │
    │              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 │
    └──────────────────────┘

``>>>nicecal.month(2038, 1, show_month_info=2, show_days=0)``
::

    ┌──────────────────────┐
    │     January 2038     │
    │              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 │
    └──────────────────────┘

``>>>nicecal.month(2038, 1, show_month_info=0, show_days=0)``
::

    ┌──────────────────────┐
    │              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 │
    └──────────────────────┘


