########## tkcalendar ##########

tkcalendar is a python module that provides the Calendar and DateEntry widgets for Tkinter. The DateEntry widget is similar to a Combobox, but the drop-down is not a list but a Calendar to select a date. Events can be displayed in the Calendar with custom colors and a tooltip displays the event list for a given day. tkcalendar is compatible with both Python 2 and Python 3. It supports many locale settings (e.g. 'fr_FR', 'en_US', ..) and the colors are customizable.

The documentation is also available here: https://tkcalendar.readthedocs.io

.. contents:: Table of Contents

Requirements

Linux, Windows, OSX
Python 3

And the python packages:

tkinter (included in the python distribution for Windows)
babel <https://pypi.org/project/babel/>_

Installation

Ubuntu: use the PPA ppa:j-4321-i/ppa <https://launchpad.net/~j-4321-i/+archive/ubuntu/ppa>__

  $ sudo add-apt-repository ppa:j-4321-i/ppa
  $ sudo apt-get update
  $ sudo apt-get install python(3)-tkcalendar

Archlinux:

The package is available on AUR <https://aur.archlinux.org/packages/python-tkcalendar>__
With pip:

::
```
  $ pip install tkcalendar
```

Documentation

Calendar widget

Syntax


    ::

        Calendar(master=None, **kw)

Widget keyword options

Standard options

cursor : str cursor to display when the pointer is in the widget

font : str such as "Arial 20 bold" or a Tkinter Font instance font of the calendar

borderwidth : int width of the border around the calendar

state : str "normal" or "disabled" (unresponsive widget)
Widget-specific options:

year : int intinitially displayed year, default is current year.

month : int initially displayed month, default is current month.

day : int initially selected day, if month or year is given but not day, no initial selection, otherwise, default is today.

firstweekday : "monday" or "sunday" first day of the week

weekenddays : list days to be displayed as week-end days given as a list of integers corresponding to the number of the day in the week (e.g. [6, 7] for the last two days of the week).

mindate : datetime.date or datetime.datetime (default is None) minimum allowed date

maxdate : datetime.date or datetime.datetime (default is None) maximum allowed date

showweeknumbers : bool (default is True) whether to display week numbers.

showothermonthdays : bool (default is True) whether to display the last days of the previous month and the first of the next month.

locale : str locale to use, e.g. 'en_US'

date_pattern : str date pattern used to format the date as a string. The default pattern used is babel's short date format in the calendar's locale.
```
  A valid pattern is a combination of 'd', 'm' and 'y' separated by
  non letter characters to indicate how and in which order the
  year, month and day should be displayed.

  =  =========================================================================
  d  'd' for the day of month number without padding, 'dd' for a two-digit day

  m  'm' for the month number without padding, 'mm' for a two-digit month

  y  'yy' for the two last digits of the year, any other number of 'y's for
     the full year with an extra padding of zero if it has less digits than
     the number of 'y's.
  =  =========================================================================

  Examples for ``datetime.date(2019, 7, 1)``

  - 'y-mm-dd' → '2019-07-01'
  - 'm/d/yy' → '7/1/19'
```
selectmode : "none" or "day" (default) whether the user can change the selected day with a mouse click.

textvariable : StringVar connect the currently selected date to the variable.
Style options:

background : background color of calendar border and month/year name

foreground : foreground color of month/year name

disabledbackground : str background color of calendar border and month/year name in disabled state

disabledforeground : str foreground color of month/year name in disabled state

bordercolor : day border color

headersbackground : background color of day names and week numbers

headersforeground : foreground color of day names and week numbers

selectbackground : background color of selected day

selectforeground : foreground color of selected day

disabledselectbackground : background color of selected day in disabled state

disabledselectforeground : foreground color of selected day in disabled state

normalbackground : background color of normal week days

normalforeground : foreground color of normal week days

weekendbackground : background color of week-end days

weekendforeground : foreground color of week-end days

othermonthforeground : foreground color of normal week days belonging to the previous/next month

othermonthbackground : background color of normal week days belonging to the previous/next month

othermonthweforeground : foreground color of week-end days belonging to the previous/next month

othermonthwebackground : background color of week-end days belonging to the previous/next month

disableddaybackground : background color of days in disabled state

disableddayforeground : foreground color of days in disabled state
Tooltip options (for calevents):

tooltipforeground : tooltip text color

tooltipbackground : tooltip background color

tooltipalpha : float tooltip opacity between 0 and 1

tooltipdelay : int delay in ms before displaying the tooltip

Virtual Events


    * A ``<<CalendarSelected>>`` event is generated each time the user selects a day with the mouse.

    * A ``<<CalendarMonthChanged>>`` event is generated each time the user changes the displayed month.

Widget methods

* Standard methods:

    - methods common to all tkinter widgets
      (more details `here <http://infohost.nmt.edu/tcc/help/pubs/tkinter/web/universal.html>`__)

    - methods common to all ttk widgets
      (more details `here <http://infohost.nmt.edu/tcc/help/pubs/tkinter/web/ttk-Widget.html>`__)

* Widget-Specific methods:

    calevent_cget(ev_id, option) :
        Return value of given option for the event *ev_id*.

    calevent_configure(ev_id, \*\*kw) :
        Return value of given option for the event *ev_id*.

    calevent_create(date, text, tags=[]) :
        Add new event in calendar and return event id.

        Options:

            *date*: ``datetime.date`` or ``datetime.datetime`` instance.

            *text*: text to put in the tooltip associated to date.

            *tags*: list of tags to apply to the event. The last tag determines the way the event is displayed.
            If there are several events on the same day, the lowest one (on the tooltip list)
            which has tags determines the colors of the day.

    calevent_lower(ev_id, below=None) :
        Lower event *ev_id* in tooltip event list.

            *below*: put event below given one, if below is None, put it at the bottom of tooltip event list.

        The day's colors are determined by the last tag of the lowest event which has tags.

    calevent_raise(ev_id, above=None) :
        Raise event *ev_id* in tooltip event list.

            *above*: put *ev_id* above given one, if above is None, put it on top of tooltip event list.

        The day's colors are determined by the last tag of the lowest event which has tags.

    calevent_remove(\*ev_ids, \*\*kw) :
        Remove events from calendar.

            Arguments: event ids to remove or 'all' to remove them all.

            Keyword arguments: *tag*, *date*. They are taken into account only if no id is given.
            Remove all events with given tag on given date. If only date is given,
            remove all events on date and if only tag is given, remove all events with tag.

    get_date() :
        If selectmode is 'day', return the string corresponding to the selected date in the
        ``Calendar`` locale, otherwise return ``""``.

    get_calevents(date=None, tag=None) :
        Return event ids of events with given tag and on given date.

            If only *date* is given, return event ids of all events on date.

            If only *tag* is given, return event ids of all events with tag.

            If both options are None, return all event ids.

    get_displayed_month() :
        Return the currently displayed month in the form of a (month, year) tuple.

    see(date) :
        Display the month in which *date* is.

            *date*: ``datetime.date`` or ``datetime.datetime`` instance.

    selection_clear() :
        Clear the selection.

    selection_get() :
        If selectmode is 'day', return the selected date as a ``datetime.date``
        instance, otherwise return ``None``.

    selection_set(self, date) :
        If selectmode is 'day', set the selection to *date* where *date* can be either a ``datetime.date``
        instance or a string corresponding to the date format ``"%x"`` in the ``Calendar``
        locale. Does nothing if selectmode is ``"none"``.

    tag_cget(tag, option) :
        Return the v

Tkcalendar

Install / Use

README

Requirements

Installation

Documentation

Calendar widget