Metadata-Version: 2.4
Name: zeal-builder
Version: 0.2.0
Summary: Create and configure a LINE Messaging API echo bot from your terminal.
Author: stoday
Author-email: stoday <stoday@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: playwright>=1.55,<2
Requires-Python: >=3.11
Project-URL: Repository, https://github.com/stoday/ZEAL
Project-URL: Issues, https://github.com/stoday/ZEAL/issues
Description-Content-Type: text/markdown

# ZEAL

[繁體中文](https://github.com/stoday/ZEAL/blob/main/README.zh-TW.md) | English

ZEAL (**Zona's Easy Adapter for Lin-bot**) helps you quickly create and
configure a LINE Bot.

Inspired by [Zona](https://github.com/zonawang), ZEAL aims to help anyone who
wants to build a LINE Bot finish the basic setup quickly, so they can spend
their time developing the Bot itself.

## Before you begin

- Python 3.11 or later
- [uv](https://docs.astral.sh/uv/)
- A LINE account that can sign in to LINE Business
- An ngrok account and authtoken

## Install

Install the published package from PyPI:

```powershell
uv tool install zeal-builder
```

To work from the source checkout instead:

```powershell
git clone https://github.com/stoday/ZEAL.git
cd ZEAL
uv sync
```

## Run

```powershell
zeal line-bot setup
```

From the source checkout, use:

```powershell
uv run zeal line-bot setup
```

Follow the terminal prompts to enter the required account information. When
LINE opens a browser and asks you to sign in, enter an OTP/MFA code, or confirm
that you are human, complete that step yourself. Press Enter after signing in;
ZEAL returns to the account form and continues filling it. If sign-in is still
in progress, the browser stays open and ZEAL asks again. ZEAL performs the
remaining supported setup automatically. If setup stopped before writing
`.env`, rerun the same command with the same details to reuse an unchanged
local project.

At the end, scan the QR code, send the Bot a message, and confirm the reply.
ZEAL creates `line-bot-<account-name>/`; edit `app.py` there to change the
Bot's reply. Keep `.env` private.

## Other commands

```powershell
# Keep the local Bot and ngrok running after setup
zeal line-bot setup --keep-running

# Set up a local Bot project for an existing LINE Messaging API channel
zeal line-bot resume

# View all available options
zeal line-bot setup --help
zeal line-bot resume --help
```

When working from the source checkout, prefix these commands with `uv run`.

After setup, use [LINE Official Account Manager](https://manager.line.biz/) to
edit account details and automatic replies. Use the
[LINE Developers Console](https://developers.line.biz/console/) to edit the
Webhook and Messaging API settings.

For a detailed manual walkthrough in Traditional Chinese, see
[line-bot-apply.md](https://github.com/stoday/ZEAL/blob/main/line-bot-apply.md).
