Calendar Widget for use with python tkinter

INSTALLATION

Install the calendar widget using the following commands

pip install calendar_widget

USAGE

First, Import the calendar widget along with tkinter

import tkinter
from calendar_widget import Calendar

Define the tkinter window into which the widget will be placed. EXAMPLE:

root = tkinter.Tk()
root.geometry('600x600')

The Calendar Widget can then be created as follows:

Calendar = Calendar(root)

To pass a command to the Calendar, specify the command option when it is created

Calendar = Calendar(root, command=user_command, ...)

To retrieve a selected date on the calendar, use the getdate() command:

Calendar.getdate()

To retrieve the current date as specified by the operating system, use the getdate_today() command:

Calendar.getdate_today()

To create a checkbox on the calendar, the command is as follows:

checkbox = Calendar.checkboxes(10, 10, 2022, status=True, ...)

#to remove a chcekbox that has already been created specify the delete option as follows:

Calendar.checkboxes(10, 10, 2022, delete=True)

To destroy the calendar widget, call the destroy method:

Calendar.destroy()

Example 1 - Basic Setup

# import tkinter and the calendar widget
import tkinter
from calendar_widget import Calendar

# define the main window into which the widget will be placed
root = tkinter.Tk()
root.geometry('600x600')  # the geometry function defines the size of the tkinter window
                          # - in this case, we are using a window that is 600px by 600px

# create the calendar widget
Calendar = Calendar(root, # specify the tkinter window into which the widget will be placed
	pos_x = 0, # set the x position of the calendar widget within the tkinter window
	pos_y = 0, # set the y position of the calendar widget within the tkinter window
	background = 'lightblue', # set the background of the calendar to light blue
	)

# Note: images of the type 'png', 'gif', 'ppm', and 'pgm' can be set as the background.
# However, these images will not scale with the size of the calendar.

# remember to call your mainloop function so that the tkinter window is persistent
root.mainloop()

Note: if no 'pos_x' or 'pos_y' parameters are given, the Calendar widget will default to using the standard pack function.

Example 2 - Binding a command to the calendar

# the 'Calendar_Click' function retrives the date selected on the Calendar by the user, and prints the date to the console
def Calendar_Click():
	print(Calendar.getdate())

# create the calendar widget
Calendar = Calendar(root,
	pos_x = 0,
	pos_y = 0, 
	background = 'lightblue', 
	command = Calendar_Click  # link the 'Calendar_Click' function to the widget
	)

Note: Only a single command can be linked to the calendar widget.

Widget Parameters - functionality and styling

The table below specifies opitons availiable for styling and other operations associated with the calendar widget