# tkintertools

**Repository Path**: young-shi/tkintertools

## Basic Information

- **Project Name**: tkintertools
- **Description**: The tkintertools is a UI framework based on the Canvas class of tkinter.
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://xiaokang2022.github.io/tkintertools/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 9
- **Created**: 2024-08-15
- **Last Updated**: 2024-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">tkintertools</h1>

<p align="center"><img alt="logo" src="https://xiaokang2022.github.io/tkintertools/logo.png" title="Logo" /></p>

<p align="center">
<code>tkintertools</code> 是一个基于 <code>tkinter</code> 的 <code>Canvas</code> 类的 UI 框架
<br/>
<code>tkintertools</code> is a UI framework based on the <code>Canvas</code> class of <code>tkinter</code>
</p>

<p align="center">
<a href="https://github.com/Xiaokang2022/tkintertools/releases"><img alt="Version" src="https://img.shields.io/github/v/release/Xiaokang2022/tkintertools?include_prereleases&logo=github&label=Version" title="Latest Version" /></a>
<a href="https://pypistats.org/packages/tkintertools"><img alt="Downloads" src="https://img.shields.io/pypi/dm/tkintertools?label=Downloads&logo=pypi&logoColor=skyblue" title="Downloads" /></a>
<a href="https://pepy.tech/project/tkintertools"><img alt="Total Downloads" src="https://img.shields.io/pepy/dt/tkintertools?logo=pypi&logoColor=gold&label=Total%20Downloads" title="Total Downloads" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools"><img alt="Size" src="https://img.shields.io/github/languages/code-size/Xiaokang2022/tkintertools?label=Size&logo=github" title="Code Size"/></a>
<br/>
<a href="https://github.com/Xiaokang2022/tkintertools/watchers"><img alt="Watchers" src="https://img.shields.io/github/watchers/Xiaokang2022/tkintertools?label=Watchers&logo=github&style=flat" title="Watchers" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools/forks"><img alt="Forks" src="https://img.shields.io/github/forks/Xiaokang2022/tkintertools?label=Forks&logo=github&style=flat" title="Forks" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/Xiaokang2022/tkintertools?label=Stars&color=gold&logo=github&style=flat" title="Stars" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools/issues"><img alt="Issues" src="https://img.shields.io/github/issues/Xiaokang2022/tkintertools?label=Issues&logo=github" title="Issues" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools/pulls"><img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/Xiaokang2022/tkintertools?label=Pull%20Requests&logo=github" title="Pull Requests" /></a>
<a href="https://github.com/Xiaokang2022/tkintertools/discussions"><img alt="Discussions" src="https://img.shields.io/github/discussions/Xiaokang2022/tkintertools?label=Discussions&logo=github" title="Discussions" /></a>
</p>

<p align="center">
<a href="https://github.com/Xiaokang2022/tkintertools/pulse"><img alt="Insights" src="https://repobeats.axiom.co/api/embed/ab8fae686a5a96f91fa71c40c53c189310924f5e.svg" /></a>
</p>

<p align="center">
    <a href="https://star-history.com/#Xiaokang2022/tkintertools&Date">
        <picture>
            <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Xiaokang2022/tkintertools&type=Date&theme=dark" />
            <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Xiaokang2022/tkintertools&type=Date" />
            <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Xiaokang2022/tkintertools&type=Date" />
        </picture>
    </a>
</p>

📦 Installation / 安装
----------------------

> [!TIP]  
> Most of the preview content of the following two versions can be found in the official [demo repository](https://github.com/Xiaokang2022/tkintertools-demos)  
> 下面两个版本的预览内容大多可以在官方[演示仓库](https://github.com/Xiaokang2022/tkintertools-demos)中找到

### ✅ Stable Version / 稳定版本

* 🔖 Version / 最新版本 : `2.6.21`
* 🕓 Release / 发布日期 : 2024-01-01
* ✨ Feature / 更新内容 : [News-2.6.21](https://xiaokang2022.github.io/tkintertools/2.6/news/2.6.21/News/)

```bash
pip install tkintertools
```

<details open><summary>👁️ Preview / 预览</summary>

![](https://xiaokang2022.github.io/tkintertools-docs/2.6/tutorials/images/1.2-2.1-2.png)

![](https://xiaokang2022.github.io/tkintertools-docs/2.6/tutorials/images/7.3-3.1-2.png)

</details>

### 🔥 Dev Version / 开发版本

* 🔖 Version / 最新版本 : `3.0.0.rc1`
* 🕓 Release / 发布日期 : 2024-08-08
* ✨ Feature / 更新内容 : [News-3.0.0](https://xiaokang2022.github.io/tkintertools/3.0/news/3.0.0/News/)

```bash
pip install tkintertools[recommended]==3.0.0rc1
```

<details open><summary>👁️ Preview / 预览</summary>

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo9-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo9-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo9-3.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo9-4.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo0-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo0-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo1-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo1-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo3.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo4-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo4-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo5-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo5-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo6-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo7-1.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo7-2.png?raw=true)

![](https://github.com/Xiaokang2022/tkintertools-demos/blob/main/preview/demo8-1.png?raw=true)

</details>

📦 Dependency / 依赖包
----------------------

> [!NOTE]  
> All dependencies are listed in [*requirements.txt*](./requirements.txt), but optional packages don't have to be installed  
> 所有的依赖包均会在 [*requirements.txt*](./requirements.txt) 中列出，但可选包并不一定要安装

### 📌 Requirements / 必需包

Not yet  
暂无

### 🎨 Options / 可选包

Considering that too many packages will result in a large size of the project file when packing, the optional packages selected below are recommended to be installed  
考虑到调用的包过多将导致打包时项目文件的大小过大，因此下面被选中的可选包是推荐安装的

- [X] [darkdetect](https://github.com/albertosottile/darkdetect) - `0.8.0`
- [X] [pywinstyles](https://github.com/Akascape/py-window-styles) - `1.8`
- [X] [pillow](https://github.com/python-pillow/Pillow) - `>=10.0.0`
- [ ] [hPyT](https://github.com/Zingzy/hPyT) - `1.3.2`
- [ ] [win32material](https://github.com/littlewhitecloud/win32style) - `1.0.6`

The following command installs the recommended optional dependencies:  
以下命令可以安装推荐的可选依赖包：

```bash
pip install tkintertools[recommended]==3.0.0rc1
```

The following command installs all optional dependencies:  
以下命令可以安装全部可选依赖包：

```bash
pip install tkintertools[all]==3.0.0rc1
```

📦 Extension / 扩展包
---------------------

In addition to the basic functionality, `tkintertools` also offers some extension packages to implement certain functionality. The following official extensions are available:  
除了基础功能之外，`tkintertools` 还提供一些扩展包来实现某些特定的功能。目前已有的官方扩展包如下：

- [X] [tkintertools-mpl](https://github.com/Xiaokang2022/tkintertools-mpl) - `1.0.0`
- [X] [tkintertools-3d](https://github.com/Xiaokang2022/tkintertools-3d) - `1.0.0`

The following command can be used to install all the official extensions:  
以下命令可以安装全部的官方扩展包：

```bash
pip install tkintertools[extension]==3.0.0rc1
```

👀 More / 更多
--------------

* 📋 Todo / 待办事项: [*TODO.md*](TODO.md)
* 📑 License / 项目许可: [*LICENSE.txt*](LICENSE.txt)
* 📘 Changelog / 更新日志: [*CHANGELOG.md*](CHANGELOG.md)
* 📕 Security Policy / 安全策略: [*SECURITY.md*](SECURITY.md)
* 📗 Contribution Guide / 贡献指南: [*CONTRIBUTING.md*](CONTRIBUTING.md)
* 📙 Code of Conduct / 行为准则: [*CODE_OF_CONDUCT.md*](CODE_OF_CONDUCT.md)
* 📚 Tutorials and Documents / 教程和文档: [Tutorials & Documents](https://xiaokang2022.github.io/tkintertools/)
* ❤️ Sponsor this Project / 赞助此项目: [Sponsor](https://xiaokang2022.github.io/tkintertools/Sponsor/)
* 🚀 Repository Mirrors / 存储库镜像源:
[GitHub](https://github.com/Xiaokang2022/tkintertools) |
[Gitee](https://gitee.com/Xiaokang2022/tkintertools) |
[GitCode](https://gitcode.com/Xiaokang2022/tkintertools/overview)