Metadata-Version: 2.4
Name: CTkDeb
Version: 0.3.1
Summary: A tool for easily packaging CustomTkinter projects into DEBs
Author-email: limafresh <173814432+limafresh@users.noreply.github.com>
Maintainer-email: limafresh <173814432+limafresh@users.noreply.github.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/limafresh/CTkDeb
Project-URL: Documentation, https://github.com/limafresh/CTkDeb
Project-URL: Repository, https://github.com/limafresh/CTkDeb.git
Project-URL: Issues, https://github.com/limafresh/CTkDeb/issues
Project-URL: Changelog, https://github.com/limafresh/CTkDeb/blob/main/CHANGELOG.md
Keywords: gui,customtkinter,deb,linux,package
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: gui
Requires-Dist: customtkinter; extra == "gui"
Dynamic: license-file

# CTkDeb

![Static Badge](https://img.shields.io/badge/No-PyInstaller-blue?style=for-the-badge)
![Static Badge](https://img.shields.io/badge/Simple-GUI-blue?style=for-the-badge)

<p align="center">
    <img src="https://raw.githubusercontent.com/limafresh/CTkDeb/main/ctkdeb/icon.png" width="100" height="100">
</p>

The easiest way to create a DEB of your CustomTkinter project! You can create a small DEB without deep packaging experience.

## Install

```bash
pip install "CTkDeb[gui] @ git+https://github.com/limafresh/CTkDeb.git"
```

Packaging requires the `dpkg-deb` tool (it is pre-installed on most Debian-like systems, so you probably won't need to install it separately).

## Run

Run this in the project folder (relative to which the paths in the config are specified)

```
ctkdeb-gui
```

## GUI

![Screenshot](https://raw.githubusercontent.com/limafresh/CTkDeb/main/screenshot.png)

## CLI

```
ctkdeb config.json
```

View all arguments:

```
ctkdeb --help
```

## Python

```python
from ctkdeb import Packager

packager = Packager("config.json")
packager.create_deb()
```

Arguments:

| Argument | Type | Description |
|-|-|-|
| **json_path** | *str* | Path to the JSON config, required |
| **project_folder** | *str* | Path to the project folder (if the command is not executed from it) |
| **desktop_entry** | *str* | Path to the custom desktop entry (or its text) |
| **output_folder** | *str* | Path to the output folder |

## FAQ

- Do I need to specify Tkinter and CustomTkinter as dependencies?

No, CTkDeb has already taken care of that; just specify third-party dependencies, if any.

## Other

App icon: Claude Sonnet 5.
