Py2exe-GUI/README_zh.md

112 lines
3.4 KiB
Markdown
Raw Normal View History

![Py2exe-GUI Logo](docs/source/images/py2exe-gui_logo_big.png)
<h2 align="center">强大易用的 Python 图形界面打包工具</h2>
<p align="center">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/muziing/Py2exe-GUI">
<img alt="Python Version" src="https://img.shields.io/pypi/pyversions/py2exe-gui">
<a href="https://pypi.org/project/py2exe-gui/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/py2exe-gui"></a>
<a href="https://pypi.org/project/py2exe-gui/"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/py2exe-gui.svg?label=PyPI%20downloads"></a>
2023-12-20 18:27:44 +08:00
</p>
<p align="center">
<a href="https://doc.qt.io/qtforpython/index.html"><img alt="PySide Version" src="https://img.shields.io/badge/PySide-6.6-blue"></a>
2023-12-20 18:27:44 +08:00
<a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://mypy-lang.org/"><img alt="Checked with mypy" src="https://img.shields.io/badge/mypy-checked-blue"></a>
</p>
<p align="center">
<a href="README.md">English</a> | 简体中文
</p>
## 简介
Py2exe-GUI 是一个基于 [PySide6](https://doc.qt.io/qtforpython/index.html) 开发的辅助工具,旨在为 [PyInstaller](https://pyinstaller.org/) 提供完整易用的图形化界面,方便用户进行 Python 项目的打包。
2023-12-20 18:27:44 +08:00
![界面截图](docs/source/images/Py2exe-GUI_v0.2.0_screenshot.png)
有如下特性:
- 完全图形化界面,易用
- 支持 PyInstaller 的全部选项
2023-12-20 18:27:44 +08:00
- (暂未实现)可以调用本地任一 Python 解释器与对应环境,无需在每个待打包的解释器环境中重复安装
- 跨平台,支持 Windows、Linux、MacOS
## 如何使用
> 注意Py2exe-GUI 尚处早期开发阶段,使用方式可能频繁变化,注意经常查阅此使用说明。
### 方式1通过 `pip` 安装
首先在待打包的 Python 解释器环境中安装 PyInstaller:
```shell
pip install pyinstaller
```
然后通过 pip 安装 Py2exe-GUI
```shell
pip install py2exe-gui
```
运行
```shell
py2exe-gui
```
如果以脚本形式运行失败,还可以尝试作为 Python 包运行:
```shell
python -m py2exe_gui # 注意连字符为_
```
### 方式2通过仓库源码运行
克隆仓库:
```shell
git clone https://github.com/muziing/Py2exe-GUI.git
```
安装 [Poetry](https://python-poetry.org/) 并创建虚拟环境
```shell
poetry init
```
安装依赖项:
```shell
poetry install
```
运行 src 目录下的 [Py2exe-GUI.py](src/Py2exe-GUI.py):
```shell
cd src
python Py2exe-GUI.py
```
## 开源许可
![GPLv3](docs/source/images/gplv3-127x51.png)
```text
Py2exe-GUI
Copyright (C) 2022-2023 muzing
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```