PamGram/README.md

<h1 align="center">PaiGram</h1>

<div align="center"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="">
<img src="https://img.shields.io/badge/works%20on-my%20machine-brightgreen" alt="">
<img src="https://img.shields.io/badge/status-%E5%92%95%E5%92%95%E5%92%95-blue" alt="">
<a href="https://black.readthedocs.io/en/stable/index.html"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="code_style" /></a>
<a href="https://www.codacy.com/gh/PaiGramTeam/PaiGram/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=PaiGramTeam/PaiGram&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/ac5844e2b0d14a3e8aa16b9b1b099ce0" alt=""/></a>
</div>

<p>
<img src="https://user-images.githubusercontent.com/70872201/190447002-119a8819-b111-4a96-a0b3-701c5e256137.png" align="right" width="100px" alt="">
<h2 align="left">简介</h2>

基于 [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) 的 PaiGram


![Alt](https://repobeats.axiom.co/api/embed/f73c1121006cb86196f83da2170242b7a97f8be0.svg "Repobeats analytics image")

## 环境需求

- Python 3.11+
- MySQL or SQLite
- Redis

## 使用方法

### 1. 安装 `poetry`

```bash
pip install --upgrade poetry
```

### 2. 安装依赖

```bash
poetry install
poetry run playwright install chromium
```

#### 可选依赖项

```bash
poetry install --extras pyro
```

### 3. 修改配置

创建 `.env` 文件并填写数据库连接和 bot token 等参数。

```bash
cp .env.example .env
```

详细配置说明见 [Wiki/Env Settings](https://github.com/PaiGramTeam/PaiGram/wiki/Env-Settings)

### 4. 初始化数据库

```bash
poetry run alembic upgrade head
```

### 5. 运行

```bash
poetry run python ./run.py
```

## 使用 Docker 部署

详见 [Wiki/Deploy with Docker](https://github.com/PaiGramTeam/PaiGram/wiki/Deploy-with-Docker)

## 使用 Podman 部署

详见 [Wiki/Deploy with Podman](https://github.com/PaiGramTeam/PaiGram/wiki/Deploy-with-Podman)

## 其他说明

这个项目目前正在扩展，加入更多原神相关娱乐和信息查询功能，敬请期待。

## Thanks

|                                   Nickname                                    | Introduce                        |
| :---------------------------------------------------------------------------: | -------------------------------- |
|        [原神抽卡全机制总结](https://www.bilibili.com/read/cv10468091)         | 本项目抽卡模拟器使用的逻辑       |
| [西风驿站 猫冬](https://bbs.mihoyo.com/ys/accountCenter/postList?id=74019947) | 本项目攻略图图源                 |
|              [Yunzai-Bot](https://github.com/Le-niao/Yunzai-Bot)              | 本项使用的抽卡图片和前端资源来源 |
|          [Crawler-ghhw](https://github.com/DGP-Studio/Crawler-ghhw)           | 本项目参考的爬虫代码             |
|                     [Enka.Network](https://enka.network)                      | 角色卡片的数据来源               |
|         [miao-plugin](https://github.com/yoimiya-kokomi/miao-plugin)          | 角色卡片的参考项目               |