Skip to content

Commit c6c9ed1

Browse files
AshhadDevLabAshhadDevLab
authored
Commit: Release v3.0.0
1 parent 7145afe commit c6c9ed1

File tree

1 file changed

+84
-22
lines changed

1 file changed

+84
-22
lines changed

‎README.md‎

Lines changed: 84 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
1-
# Python CustomTkinter Snippets
1+
# CustomTkinter Snippets
22

3-
Welcome to the Python CustomTkinter Snippets repository! This repository contains a curated collection of Python CustomTkinter code snippets to help you build interactive graphical user interfaces (GUIs) effortlessly.
3+
![CustomTkinter Snippets Banner](images/customtkinter_snippets_banner.png)
44

5-
## About CustomTkinter
5+
CustomTkinter Snippets is a Visual Studio Code extension that provides a comprehensive set of snippets for efficiently working with CustomTkinter, a custom toolkit for Python GUI development. This extension enhances your development workflow by offering quick access to commonly used CustomTkinter components and features directly within the VS Code editor.
66

7-
CustomTkinter is a custom version of the standard Tkinter GUI library for Python developed by [Tom Schimansky](https://github.com/TomSchimansky). You can find the CustomTkinter repository [here](https://github.com/TomSchimansky/CustomTkinter). It provides a fast and easy way to create GUI applications. With CustomTkinter, you can create windows, labels, buttons, menus, and much more to build powerful desktop applications.
7+
## Features
88

9-
## Repository Structure
9+
- **Efficient Workflow**: Speed up your development process with easy-to-use snippets for creating CustomTkinter widgets and implementing various functionalities.
1010

11-
The repository is organized into folders based on different aspects of CustomTkinter functionality. Each folder contains code snippets focusing on a specific feature or task. Here's a brief overview of the repository structure:
11+
- **Comprehensive Coverage**: Access snippets for a wide range of CustomTkinter components, including buttons, checkboxes, combo boxes, entry fields, frames, labels, option menus, progress bars, radio buttons, scrollable frames, segmented buttons, sliders, switches, tab views, textboxes, scrollbars, windows, images, fonts, top-level windows, input dialogs, and more.
1212

13-
- `layout`: Snippets related to arranging widgets within a CustomTkinter window.
14-
- `events`: Snippets demonstrating event handling in CustomTkinter.
15-
- `widgets`: Snippets showcasing various CustomTkinter widgets such as buttons, labels, entry fields, etc.
16-
- `dialogs`: Snippets for creating dialog boxes and pop-up windows.
17-
- `styling`: Snippets illustrating how to customize the appearance of CustomTkinter widgets using styles and themes.
18-
- `examples`: Complete examples demonstrating the integration of multiple CustomTkinter components to create functional GUI applications.
13+
- **Customization Options**: Utilize snippets to set appearance modes, themes, widget scaling, window scaling, and automatic DPI awareness according to your application requirements.
1914

20-
## How to Use
15+
## Installation
2116

22-
Each snippet is self-contained and focused on a specific aspect of CustomTkinter. Simply browse through the folders to find the snippet that meets your requirements. Each snippet includes comments explaining its purpose and usage. You can copy and paste the code into your own Python scripts or projects.
17+
1. Open Visual Studio Code.
18+
2. Go to the Extensions view by clicking on the square icon in the Sidebar or pressing `Ctrl+Shift+X`.
19+
3. Search for "CustomTkinter Snippets".
20+
4. Click on the Install button.
2321

24-
## Contribution
22+
## Usage
2523

26-
Contributions to this repository are highly encouraged! If you have any useful CustomTkinter snippets that you would like to share with the community, please follow the [contribution guidelines](CONTRIBUTING.md) to contribute your snippets. Together, we can make this repository a valuable resource for CustomTkinter developers.
24+
1. Open a Python file in Visual Studio Code.
25+
2. Type the snippet prefix (e.g., `ctkbutton` for a button widget) and press `Tab` to insert the snippet code.
26+
3. Customize the snippet code as needed for your application.
2727

28-
## Code of Conduct
28+
## Example
2929

30-
Please note that by contributing to this repository, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to uphold the principles of respect and inclusivity.
30+
![CustomTkinter Snippets Example GIF](images/customtkinter_snippets_example_gif.gif)
3131

32-
## License
32+
## Snippets
33+
34+
### Widgets
35+
36+
| Prefix | Snippet Description |
37+
| -------------------- | -------------------------------------------------------------------------------- |
38+
| `ctkwindow` | Inserts a snippet to create base CustomTkinter window |
39+
| `ctkbutton` | Inserts a snippet for button widget |
40+
| `ctkcheckbox` | Inserts a snippet for checkbox widget |
41+
| `ctkcombobox` | Inserts a snippet for combo box widget |
42+
| `ctkentry` | Inserts a snippet for entry field widget |
43+
| `ctkframe` | Inserts a snippet for frame widget |
44+
| `ctklabel` | Inserts a snippet for label widget |
45+
| `ctkoptionmenu` | Inserts a snippet for option menu widget |
46+
| `ctkprogressbar` | Inserts a snippet for progress bar widget |
47+
| `ctkradiobutton` | Inserts a snippet for radio button widget |
48+
| `ctkscrollableframe` | Inserts a snippet for scrollable frame widget |
49+
| `ctksegmentedbutton` | Inserts a snippet for segmented button widget |
50+
| `ctkslider` | Inserts a snippet for slider widget |
51+
| `ctkswitch` | Inserts a snippet for switch widget |
52+
| `ctktabview` | Inserts a snippet for tab view widget |
53+
| `ctktextbox` | Inserts a snippet for textbox widget |
54+
| `ctkscrollbar` | Inserts a snippet for scrollbar widget |
55+
| `ctkimage` | Inserts a snippet for importing images using [Pillow](https://python-pillow.org) |
56+
| `ctkfont` | Inserts a snippet for importing external font families |
57+
| `ctktoplevel` | Inserts a snippet to create secondary top-level CustomTkinter window |
58+
| `ctkinputdialog` | Inserts a snippet for input dialog widget |
59+
60+
### Appearance and Theme
61+
62+
| Prefix | Snippet Description |
63+
| --------------- | ----------------------------------------------- |
64+
| `appsys` | Inserts a snippet for copying System Appearance |
65+
| `appdark` | Inserts a snippet for setting Dark Appearance |
66+
| `applight` | Inserts a snippet for setting Light Appearance |
67+
| `themegreen` | Inserts a snippet for setting Green Theme |
68+
| `themeblue` | Inserts a snippet for setting Blue Theme |
69+
| `themedarkblue` | Inserts a snippet for setting Dark Blue Theme |
70+
| `theme` | Inserts a snippet for setting Custom Theme |
71+
72+
### Scaling and DPI
73+
74+
| Prefix | Snippet Description |
75+
| --------------- | ------------------------------------------------ |
76+
| `scalingwidget` | Inserts a snippet for setting Widget Scaling |
77+
| `scalingwindow` | Inserts a snippet for setting Window Scaling |
78+
| `dpideactivate` | Inserts a snippet that deactivates DPI Awareness |
3379

34-
This repository is licensed under the [BSD 3-Clause License](LICENSE). Feel free to use the code snippets in your own projects.
80+
## Requirements
3581

36-
## Get Started
82+
- Visual Studio Code
83+
- Python
84+
- CustomTkinter library
3785

38-
Explore the folders and start building amazing GUI applications with Python CustomTkinter!
86+
## CustomTkinter Library
87+
88+
CustomTkinter Snippets is built to complement the CustomTkinter library for Python GUI development. This library is maintained by [Tom Schimansky](https://github.com/TomSchimansky), a prolific developer in the Python community.
89+
90+
- **Author Profile**: [Tom Schimansky](https://github.com/TomSchimansky)
91+
- **CustomTkinter Repository**: [CustomTkinter](https://github.com/TomSchimansky/CustomTkinter)
92+
93+
Feel free to explore the CustomTkinter repository for more information, updates, and contributions.
94+
95+
## Feedback
96+
97+
For any issues, suggestions, or feedback, please [open an issue](https://github.com/AshhadDevLab/CustomTkinter-Snippets/issues) on GitHub.
98+
99+
## License
39100

101+
This extension is licensed under the [BSD-3 License](LICENSE).

0 commit comments

Comments
 (0)