Upload 964 files (#1)

.gitattributes

@@ -33,3 +33,26 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+docs/images/bocchi_draft.gif filter=lfs diff=lfs merge=lfs -text
+docs/images/caoshen_bite.gif filter=lfs diff=lfs merge=lfs -text
+docs/images/confuse.gif filter=lfs diff=lfs merge=lfs -text
+docs/images/karyl_point.png filter=lfs diff=lfs merge=lfs -text
+docs/images/kirby_hammer_instance0.gif filter=lfs diff=lfs merge=lfs -text
+docs/images/kirby_hammer_instance1.gif filter=lfs diff=lfs merge=lfs -text
+docs/images/kirby_hammer.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/anti_kidnap/images/0.png filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/dinosaur/images/0.png filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/dog_of_vtb/images/0.png filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/gif_subtitle/images/maikease.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/gif_subtitle/images/qiegewala.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/gif_subtitle/images/shuifandui.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/gif_subtitle/images/wangjingze.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/gif_subtitle/images/weisuoyuwei.gif filter=lfs diff=lfs merge=lfs -text
+meme_generator/memes/mourning/images/0.png filter=lfs diff=lfs merge=lfs -text
+resources/fonts/FZKATJW.ttf filter=lfs diff=lfs merge=lfs -text
+resources/fonts/FZSEJW.ttf filter=lfs diff=lfs merge=lfs -text
+resources/fonts/FZSJ-QINGCRJ.ttf filter=lfs diff=lfs merge=lfs -text
+resources/fonts/FZXS14.ttf filter=lfs diff=lfs merge=lfs -text
+resources/fonts/HiraginoMin-W5-90-RKSJ-H-2.ttc filter=lfs diff=lfs merge=lfs -text
+resources/fonts/NotoSansSC-Regular.otf filter=lfs diff=lfs merge=lfs -text
+resources/fonts/NotoSerifSC-Regular.otf filter=lfs diff=lfs merge=lfs -text

.github/workflows/docker.yml

@@ -0,0 +1,66 @@
+name: Build docker image
+
+on:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to GitHub Packages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+
+      - name: Setup Docker
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to Github Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate Tags
+        uses: docker/metadata-action@v4
+        id: metadata
+        with:
+          images: |
+            ${{ github.repository }}
+            ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+
+      - name: Build and Publish
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          readme-filepath: ./docs/docker.md

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Publish python package
+        uses: JRubics/poetry-publish@v1.16
+        with:
+          pypi_token: ${{ secrets.PYPI_TOKEN }}

.github/workflows/update.yml

@@ -0,0 +1,47 @@
+name: Update resource_list.json & memes.md
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "meme_generator/memes/**"
+  workflow_dispatch:
+
+jobs:
+  update-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Setup Poetry
+        uses: Gr1N/setup-poetry@v8
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Install fonts
+        run: |
+          sudo apt install fonts-noto-cjk fonts-noto-color-emoji
+          sudo locale-gen zh_CN zh_CN.UTF-8
+          sudo update-locale LC_ALL=zh_CN.UTF-8 LANG=zh_CN.UTF-8
+          sudo mkdir /usr/share/fonts/myfonts
+          sudo cp resources/fonts/* /usr/share/fonts/myfonts/
+          fc-cache -fv
+
+      - name: Update resource_list.json
+        run: poetry run python resources/update_list.py
+
+      - name: Update memes.md
+        run: poetry run python docs/update_doc.py
+
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: "main"

.github/workflows/update_poetry_lock.yml

@@ -0,0 +1,32 @@
+name: Update poetry.lock
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "pyproject.toml"
+  workflow_dispatch:
+
+jobs:
+  update-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Setup Poetry
+        uses: Gr1N/setup-poetry@v8
+
+      - name: Update poetry.lock
+        run: poetry update --lock
+
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: "main"

.gitignore

@@ -0,0 +1,10 @@
+*__pycache__/
+dist/
+.vscode/
+.idea/
+venv/
+.venv/
+
+result.png
+result.jpg
+result.gif

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+default_install_hook_types: [pre-commit, prepare-commit-msg]
+ci:
+  autofix_commit_msg: ":rotating_light: auto fix by pre-commit hooks"
+  autofix_prs: true
+  autoupdate_branch: master
+  autoupdate_schedule: monthly
+  autoupdate_commit_msg: ":arrow_up: auto update by pre-commit hooks"
+repos:
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.1.3
+    hooks:
+      - id: pycln
+        args: [--config, pyproject.toml]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        stages: [commit]
+
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+        stages: [commit]
+

Dockerfile

@@ -0,0 +1,49 @@
+FROM python:3.10 as tmp
+
+WORKDIR /tmp
+
+ENV PATH="${PATH}:/root/.local/bin"
+
+COPY ./pyproject.toml ./poetry.lock* /tmp/
+RUN pip install poetry \
+  && poetry config virtualenvs.in-project true \
+  && poetry install --only main --no-interaction --no-ansi
+
+FROM python:3.10-slim as app
+
+WORKDIR /app
+
+EXPOSE 7860
+
+VOLUME /data
+
+COPY --from=tmp /tmp/.venv /app/.venv
+
+COPY ./resources/fonts/* /usr/share/fonts/meme-fonts/
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends locales fontconfig fonts-noto-cjk fonts-noto-color-emoji gettext \
+  && localedef -i zh_CN -c -f UTF-8 -A /usr/share/locale/locale.alias zh_CN.UTF-8 \
+  && fc-cache -fv \
+  && apt-get purge -y --auto-remove \
+  && rm -rf /var/lib/apt/lists/*
+
+ENV TZ=Asia/Shanghai \
+  LC_ALL=zh_CN.UTF-8 \
+  PATH="/app/.venv/bin:${PATH}" \
+  VIRTUAL_ENV="/app/.venv" \
+  LOAD_BUILTIN_MEMES=true \
+  MEME_DIRS="[\"/data/memes\"]" \
+  MEME_DISABLED_LIST="[]" \
+  GIF_MAX_SIZE=10.0 \
+  GIF_MAX_FRAMES=100 \
+  BAIDU_TRANS_APPID="" \
+  BAIDU_TRANS_APIKEY="" \
+  LOG_LEVEL="INFO"
+
+COPY ./meme_generator /app/meme_generator
+
+COPY ./docker/config.toml.template /app/config.toml.template
+COPY ./docker/start.sh /app/start.sh
+RUN chmod +x /app/start.sh
+
+CMD ["/app/start.sh"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 MeetWq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docker/config.toml.template

@@ -0,0 +1,19 @@
+[meme]
+load_builtin_memes = $LOAD_BUILTIN_MEMES
+meme_dirs = $MEME_DIRS
+meme_disabled_list = $MEME_DISABLED_LIST
+
+[gif]
+gif_max_size = $GIF_MAX_SIZE
+gif_max_frames = $GIF_MAX_FRAMES
+
+[translate]
+baidu_trans_appid = "$BAIDU_TRANS_APPID"
+baidu_trans_apikey = "$BAIDU_TRANS_APIKEY"
+
+[server]
+host = "0.0.0.0"
+port = 2233
+
+[log]
+log_level = "$LOG_LEVEL"

docker/start.sh

@@ -0,0 +1,7 @@
+#! /usr/bin/env bash
+
+mkdir -p ~/.config/meme_generator
+
+envsubst < /app/config.toml.template > ~/.config/meme_generator/config.toml
+
+exec python -m meme_generator.app

docs/develop.md

@@ -0,0 +1,135 @@
+# 新表情编写指北
+
+## 表情注册
+
+meme-generator 会以包的形式加载表情，通过 `add_meme` 函数来“注册”一个表情
+
+以 `petpet` 表情为例，文件结构如下：
+
+```
+meme_generator/memes/petpet
+├── __init__.py  # 表情制作程序
+└── images  # 表情需要的图片文件
+    ├── 0.png
+    ├── 1.png
+    ├── 2.png
+    ├── 3.png
+    └── 4.png
+```
+
+在不考虑额外参数的情况下，`petpet` 表情的 `__init__.py` 编写如下：
+
+```python
+from typing import List
+from pathlib import Path
+from pil_utils import BuildImage
+from PIL.Image import Image as IMG
+
+from meme_generator.utils import save_gif
+from meme_generator import add_meme
+
+
+img_dir = Path(__file__).parent / "images"
+
+
+def petpet(images: List[BuildImage], texts, args):
+    """表情制作函数
+
+    函数会接收 3 个参数：
+    - `images`: 传入的图片列表，类型为 `pil_utils.BuildImage`
+    - `texts`: 传入的文字列表，类型为 `str`
+    - `args`: 其他参数，类型为 `meme_generator.meme.MemeArgsModel`
+    """
+    img = images[0].convert("RGBA").square()
+    frames: List[IMG] = []
+    locs = [
+        (14, 20, 98, 98),
+        (12, 33, 101, 85),
+        (8, 40, 110, 76),
+        (10, 33, 102, 84),
+        (12, 20, 98, 98),
+    ]
+    for i in range(5):
+        hand = BuildImage.open(img_dir / f"{i}.png")
+        frame = BuildImage.new("RGBA", hand.size, (255, 255, 255, 0))
+        x, y, w, h = locs[i]
+        frame.paste(img.resize((w, h)), (x, y), alpha=True)
+        frame.paste(hand, alpha=True)
+        frames.append(frame.image)
+    return save_gif(frames, 0.06)
+
+
+add_meme(
+    "petpet",  # 表情唯一名
+    petpet,  # 表情制作函数
+    min_images=1,  # 至少需要 1 张图片
+    max_images=1,  # 另有 `min_texts` 和 `max_texts` 选项来控制传入文字的数量
+    keywords=["摸", "摸摸", "摸头", "rua"],  # 关键词，填写言简意赅的词语，用于展示表情含义、方便聊天Bot调用等
+)
+```
+
+通常情况下，建议每个表情一个文件夹，表情所需的图片文件等都放置于该文件夹中，方便增删表情
+
+也可以一个文件中注册多个表情，如：[gif_subtitle](../meme_generator/memes/gif_subtitle/__init__.py)
+
+
+## 参数定义
+
+部分表情需要额外的参数。表情参数的类型定义如下：
+
+```python
+@dataclass
+class MemeArgsType:
+    parser: MemeArgsParser  # 参数解析器，将命令行形式的文本解析为字典形式，方便通过命令行使用
+    model: Type[MemeArgsModel]  # 参数模型，用于验证字典形式的参数，并传入表情制作函数
+    instances: List[MemeArgsModel] = field(default_factory=list)  # 可选，参数模型示例，推荐填写，方便生成不同参数下的预览图
+```
+
+以 `petpet` 表情为例，需要定义一个控制图片是否变为圆形的参数 `circle`
+
+可以定义如下的 `pydantic` 模型：
+
+```python
+from pydantic import Field
+from meme_generator import MemeArgsModel
+
+class Model(MemeArgsModel):
+    circle: bool = Field(False, description="是否将图片变为圆形")
+```
+
+定义参数时推荐使用 `Field` 定义默认值，可以定义 `description` 描述参数含义，方便生成文档
+
+同时定义如下的参数解析器：
+
+```python
+from meme_generator import MemeArgsParser
+
+parser = MemeArgsParser(prefix_chars="-/")
+parser.add_argument("--circle", "/圆", action="store_true", help="是否将图片变为圆形")
+```
+
+以上参数解析器可以将形如 `["--circle"]` 的参数列表解析为 `{"circle": true}` 的形式，继而通过 `pydantic` 模型验证
+
+推荐在定义选项时添加自然语言风格的别名，如 `/圆`，这样可以方便聊天机器人等场合调用，比如可以解析 `摸头 /圆` 这样的文本
+
+定义好上述的 `parser` 和 `Model` 后，需要在 `add_meme` 时传入：
+
+```python
+add_meme(
+    "petpet",
+    petpet,
+    min_images=1,
+    max_images=1,
+    args_type=MemeArgsType(
+        parser,
+        Model,
+        [
+            Model(circle=False),
+            Model(circle=True),
+        ],
+    ),
+    keywords=["摸", "摸摸", "摸头", "rua"],
+)
+```
+
+这里传入了 `circle=False` 和 `circle=True` 两个模型实例，可以在生成文档时生成不同参数时的预览图，效果如 [memes.md](memes.md#petpet) 所示

docs/docker.md

@@ -0,0 +1,56 @@
+https://github.com/MeetWq/meme-generator
+
+## Docker部署
+
+### 运行
+
+```shell
+docker run -d \
+  --name=meme-generator \
+  -p 2233:2233 \
+  --restart always \
+  meetwq/meme-generator:latest
+```
+
+运行后可通过 api 方式调用
+
+
+### 环境变量
+
+| 变量名 | 默认值 | 说明 |
+| --- | --- | --- |
+| `MEME_DIRS` | `'["/data/memes"]'` | 额外表情路径 |
+| `MEME_DISABLED_LIST` | `'[]'` | 禁用表情列表 |
+| `GIF_MAX_SIZE` | `10.0` | 限制生成的 gif 文件大小 |
+| `GIF_MAX_FRAMES` | `100` | 限制生成的 gif 文件帧数 |
+| `BAIDU_TRANS_APPID` | `''` | 百度翻译 appid |
+| `BAIDU_TRANS_APIKEY` | `''` | 百度翻译 apikey |
+| `LOG_LEVEL` | `'INFO'` | 日志等级 |
+
+
+### 加载额外表情
+
+可通过 `MEME_DIRS` 环境变量指定额外表情路径，默认为 `["/data/memes"]`
+
+可将 docker 路径 `/data` 映射到本地路径 `<YOUR_DATA_DIR>`
+
+将额外表情放置于 `<YOUR_DATA_DIR>/memes` 即可
+
+
+完整的运行示例：
+
+```shell
+docker run -d \
+  --name=meme-generator \
+  -p 2233:2233 \
+  --restart always \
+  -v <YOUR_DATA_DIR>:/data \
+  -e MEME_DIRS='["/data/memes"]' \
+  -e MEME_DISABLED_LIST='[]' \
+  -e GIF_MAX_SIZE=10.0 \
+  -e GIF_MAX_FRAMES=100 \
+  -e BAIDU_TRANS_APPID=<YOUR_BAIDU_TRANS_APPID> \
+  -e BAIDU_TRANS_APIKEY=<YOUR_BAIDU_TRANS_APIKEY> \
+  -e LOG_LEVEL='INFO' \
+  meetwq/meme-generator:main
+```

docs/examples/test_api.py

@@ -0,0 +1,23 @@
+import asyncio
+import json
+
+import httpx
+
+
+async def main():
+    files = [("images", open("avatar.jpg", "rb"))]
+    texts = []
+    args = {"circle": True}
+    data = {"texts": texts, "args": json.dumps(args)}
+
+    url = "http://127.0.0.1:2233/memes/petpet/"
+    async with httpx.AsyncClient() as client:
+        resp = await client.post(url, files=files, data=data)
+
+    with open("result.gif", "wb") as f:
+        f.write(resp.content)
+
+
+if __name__ == "__main__":
+    loop = asyncio.new_event_loop()
+    loop.run_until_complete(main())

docs/examples/test_meme.py

@@ -0,0 +1,16 @@
+import asyncio
+
+from meme_generator import get_meme
+
+
+async def main():
+    meme = get_meme("petpet")
+    result = await meme(images=["avatar.jpg"], texts=[], args={"circle": True})
+
+    with open("result.gif", "wb") as f:
+        f.write(result.getvalue())
+
+
+if __name__ == "__main__":
+    loop = asyncio.new_event_loop()
+    loop.run_until_complete(main())