Metadata-Version: 2.4
Name: passagefy
Version: 1.0.0
Summary: “通途”是一个基于Django的应用，帮助用户创建一个技术反馈表，并且与飞书的多维表格进行同步
Home-page: https://github.com/spirits001/passagefy
Author: 代码厨子
Author-email: hofeng@aqifun.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Requires-Dist: djangorestframework
Requires-Dist: hadmin
Requires-Dist: django-filter
Requires-Dist: requests
Requires-Dist: djangorestframework-simplejwt
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# passagefy 「通途」 使用说明

我们结合飞书的多维表格，实现了一个基于Django的应用，帮助用户创建一个技术反馈表，并且与飞书的多维表格进行同步。

集成了HAdmin的配置文件生成功能，帮助前端进行渲染。

# 快速开始

## 安装

```bash
pip install passagefy
```

## 使用方式

- 在 settings.py 中添加 passagefy 到 INSTALLED_APPS 中

```python
INSTALLED_APPS = [
    ...,
    'passagefy'
]
```

- 并且设定两个变量，也放在settings.py中

```python
PASSAGEFY_WEBHOOK_URL = "用于发送给飞书多维表格的webhook地址"
PASSAGEFY_WEBHOOK_TOKEN = "用于验证的token，如果没设定，就不要这个"
```

**重点说明：token如果设定，那么接收和发送都是用相同的token，请注意配置飞书多维表格时设定好**

- 最后，在urls.py中添加如下代码

```python
from django.urls import path, include
from passagefy.urls import passagefyAdminRouter
from passagefy.views import passagefy_webhook

urlpatterns = [
    ...,
    path('v1/passagefy/', include(passagefyAdminRouter.urls)),  # HAdmin配置文件相关接口
    path('v1/passagefy/webhook', passagefy_webhook),  # 飞书多维表格同步接口
]
```

# 版本历史

1.0.0 初始版本
