Metadata-Version: 2.1
Name: wordcloud-webui
Version: 0.1.0
Summary: The web UI for word_cloud (text to word cloud picture converter)
Author-email: Lion A <alionsss@foxmail.com>
License: License :: OSI Approved :: Apache Software License
Project-URL: Homepage, https://github.com/AlionSSS/wordcloud-webui
Project-URL: Repository, https://github.com/AlionSSS/wordcloud-webui.git
Keywords: word-cloud,ui,webui,graph,picture,converter,text
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Multimedia :: Graphics
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gradio==4.29
Requires-Dist: wordcloud==1.9.3
Requires-Dist: jieba==0.42.1

# wordcloud-webui
The web UI for word_cloud (text to word cloud picture converter)

## 描述(Description)

- 功能：利用 [word_cloud](https://github.com/amueller/word_cloud) 将 **普通文本** 转为 **词云图像** 文件
- 可视化：使用 [Gradio](https://github.com/gradio-app/gradio) 将该功能可视化

## 界面(UI)
![image.png](https://raw.githubusercontent.com/AlionSSS/wordcloud-webui/main/doc-resources/image.png)

## 安装(Install)
- 新建一个虚拟环境(Python 3.9.16)，或使用已有的Python环境
  - 例如 `$ conda create -n env_name python=3.9`
- 使用 PIP 方式安装
  - `$ pip install wordcloud-webui`
- 使用源码方式安装
  - 下载本项目代码
    - 点击[本项目GitHub页面](https://github.com/AlionSSS/wordcloud-webui)右上角的绿色的按钮`Code`，再点击`Download ZIP`
  - 解压项目，进入到项目根目录
    - 安装，执行 `$ pip install -e ./ -i "https://pypi.doubanio.com/simple/"`
- 注
  - 卸载命令 `$ pip uninstall wordcloud-webui"`

## 启动服务(Start Service)
### 直接启动
- 由于安装时已经在当前 Python 环境中安装了 script
- 所以可以在任意位置直接执行 `$ wordcloud-gui`，启动 WebUI

### 使用代码启动
- 进入到本项目的目录下，执行 `$ cd src/wordcloud_webui`
- 二选一
  - 在本地电脑端启动，直接执行 `$ python main.py`
  - 在服务器端启动，执行 `$ nohup python main.py 1>server_run.log 2>&1 &`

## 手动构建(Build)
- 更新、安装工具
  - `$ pip install --upgrade setuptools`
  - `$ pip install --upgrade build`
- 进入到项目根目录下，执行 `$ python -m build`
- 构建完成会在项目 dist 目录下，生成 tar.gz 和 whl 文件
- 直接使用 PIP 即可安装，如 `pip install .\dist\wordcloud_webui-0.1.0-py3-none-any.whl`
