Metadata-Version: 2.4
Name: custom2kinter
Version: 5.3.0
Summary: Create modern looking GUIs with Python
Author: Tom Schimansky, Federico Spada
Maintainer: Federico Spada
License-Expression: MIT
Project-URL: Homepage, https://github.com/FedericoSpada/Custom2kinter
Project-URL: Changelog, https://github.com/FedericoSpada/Custom2kinter/blob/master/CHANGELOG.md
Project-URL: Issues, https://github.com/FedericoSpada/Custom2kinter/issues
Project-URL: Documentation, https://customtkinter.tomschimansky.com/documentation
Keywords: GUI,Tkinter,simple,modern
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: darkdetect
Requires-Dist: typing_extensions
Requires-Dist: packaging
Dynamic: license-file

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/CustomTkinter_logo_dark.png">
    <img src="https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/CustomTkinter_logo_light.png">
  </picture>
</p>

<div align="center">
  
![PyPI](https://img.shields.io/pypi/v/custom2kinter)
![PyPI - Downloads](https://img.shields.io/pypi/dm/custom2kinter?color=green&label=downloads)
![Total Downloads](https://static.pepy.tech/personalized-badge/custom2kinter?period=total&units=international_system&left_color=grey&right_color=green&left_text=total%20downloads)
![PyPI - License](https://img.shields.io/badge/license-MIT-blue)
![Minimum Python Version](https://shields.io/badge/Minimum_Python-3.7-blue)

---

| Current Developers | Contact |
|----------------------------------------------|-|
| Federico Spada | www.linkedin.com/in/federicospada13 |

<a href="https://www.paypal.com/donate/?hosted_button_id=DRC8XDXN7SEH4"><img src="https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/paypal_donate_button.png" width=250 alt="PayPal donation button"></a>


</div>

---

Custom2kinter is a python UI-library based on Tkinter, which provides new, modern and
fully customizable widgets. They are created and used like normal Tkinter widgets and
can also be used in combination with normal Tkinter elements. The widgets
and the window colors either adapt to the system appearance or the manually set mode
('light', 'dark'), and all Custom2kinter widgets and windows support HighDPI scaling
(Windows, macOS). With Custom2kinter you'll get a consistent and modern look across all
desktop platforms (Windows, macOS, Linux).

This project was created to continue the development of [CustomTkinter](https://pypi.org/project/customtkinter), since the
original author lost interest in it. The first release of this library is v5.3.0,
which continues the old numeration, and it is fully compatible with the last released
version of the original library.\
They can't live together in the same environment, so be sure to uninstall ```customtkinter```
before installing ```custom2kinter```. This library is still imported using the original
name, so existing code doesn't need to be updated.

![](https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/complex_example_dark_Windows.png)
| _`complex_example.py` on Windows 11 with dark mode and 'blue' theme_

![](https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/complex_example_light_macOS.png)
| _`complex_example.py` on macOS in light mode and standard 'blue' theme_
###


## Installation
Install the module with pip:
```
pip3 install custom2kinter
```
**Update existing installation:** ```pip3 install custom2kinter --upgrade```\
(update as often as possible because this library is under active development)

## Documentation

The **official** documentation can be found here:

**➡️ https://customtkinter.tomschimansky.com/documentation**.

## Example Program
To test custom2kinter you can try this simple example with only a single button:
```python
import customtkinter

customtkinter.set_appearance_mode("System")  # Modes: system (default), light, dark
customtkinter.set_default_color_theme("blue")  # Themes: blue (default), dark-blue, green

app = customtkinter.CTk()  # create CTk window like you do with the Tk window
app.geometry("400x240")

def button_function():
    print("button pressed")

# Use CTkButton instead of tkinter Button
button = customtkinter.CTkButton(master=app, text="CTkButton", command=button_function)
button.place(relx=0.5, rely=0.5, anchor=customtkinter.CENTER)

app.mainloop()
```
which results in the following window on macOS:

<img src="https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/single_button_macOS.png" width="400"/>

In the [examples folder](https://github.com/FedericoSpada/Custom2kinter/tree/master/examples), you
can find more example programs and in the [Documentation](https://github.com/TomSchimansky/CustomTkinter/wiki)
you can find further information on the appearance mode, scaling, themes and all widgets.

## More Examples and Showcase
You can run the following code to show a simple App that displays all available widgets:
```python
import customtkinter as ctk
ctk.run_showroom()
```

### Appearance mode change and scaling change

Custom2kinter can adapt to the Windows 10/11 light or dark mode:

https://user-images.githubusercontent.com/66446067/204672968-6584f360-4c52-434f-9c16-25761341368b.mp4

| _`complex_example.py` on Windows 11 with system appearance mode change and standard 'blue' theme_
###

On macOS you either need python3.10 or higher or the anaconda python
version to get a dark window header (Tcl/Tk >= 8.6.9 required):

https://user-images.githubusercontent.com/66446067/204673854-b6cbcfda-d9a1-4425-92a3-5b57d7f2fd6b.mp4

| _`complex_example.py` on macOS with system appearance mode change, user-scaling change and standard 'blue' theme_
###

### Button with images
It's possible to put an image on a CTkButton. You just have to
pass a PhotoImage object to the CTkButton with the ``image`` argument.
If you want no text at all you have to set ``text=""`` or you specify
how to position the text and image at once with the ``compound`` option:

![](https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/image_example_dark_Windows.png)
| _`image_example.py` on Windows 11_
###

### Scrollable Frames
Scrollable frames are possible in vertical or horizontal orientation and can be combined
with any other widgets.
![](https://raw.githubusercontent.com/FedericoSpada/Custom2kinter/refs/heads/master/documentation_images/scrollable_frame_example_Windows.png)
| _`scrollable_frame_example.py` on Windows 11_

### Integration of TkinterMapView widget
In the following example I used a TkinterMapView which integrates
well with a Custom2kinter program. It's a tile based map widget which displays
OpenStreetMap or other tile based maps:

https://user-images.githubusercontent.com/66446067/204675835-1584a8da-5acc-4993-b4a9-e70f06fa14b0.mp4

| _`examples/map_with_customtkinter.py` from TkinterMapView repository on Windows 11_

You can find the TkinterMapView library and example program here:
https://github.com/TomSchimansky/TkinterMapView
