一個簡單、強大、免費且易於擴充的多平台地震預警通知系統!
Important
此專案使用由 ExpTech 探索科技 提供的 API,請遵照其服務條款。
Note
此專案目前仍處於測試版本,可能會有重大更改。
需要 Python 3.8 或更高的版本
首先下載專案的源代碼,可以使用以下的指令取得:
git clone https://github.com/watermelon1024/EEW.git
cd EEW
在安裝專案之前,建議使用虛擬環境來隔離專案的依賴套件,以避免和其他專案的依賴套件衝突。
python -m venv venv
pip install virtualenv
virtualenv venv
接著,啟用虛擬環境:
# Windows
venv\Scripts\activate
# Linux/macOS
source venv/bin/activate
根據 .env.example
的格式編輯 .env
檔案,並填入所需的環境變數。
例如:
DISCORD_BOT_TOKEN= # Discord 機器人金鑰
LINEBOT_ACCESS_TOKEN= # Line 機器人 Access Token
LINEBOT_CHANNEL_SECRET= # Line 機器人 Channel Secret
根據 config.toml.example
的格式編輯 config.toml
檔案,並根據自身需求填入設定所需的值。
例如:
# 設定
debug-mode = false # 除錯模式
[discord-bot]
channels = [
{ id = 123456789, mention = "everyone" }, # 提及所有人 (@everyone)
{ id = 456789123, mention = 6543219870 }, # 提及 ID 為 `6543219870` 的身分組
{ id = 987654321 }, # 不提及
]
[line-bot]
channels = [
"abcdefgh...",
"ijklmnop...",
] # 使用者或是群組 ID
[log]
retention = 30 # 日誌保存的天數
format = "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <level>{message}</level>" # 日誌輸出格式
下載專案所需要的依賴套件。
pip install -r requirements.txt
安裝套件並設定環境變數後,即可執行專案!
python main.py
如果您遇到任何問題或對專案有疑問,請隨時在 GitHub Issues 頁面 提出問題。提交問題之前,請確保您已經:
- 搜尋過現有的問題,以避免重複提交。
- 提供清晰且簡要的問題描述,包括重現問題的步驟。
- 附上相關的後台日誌或錯誤訊息。
- 提供您使用的環境資訊(如 Python 版本、作業系統)和相關的配置。
您的反饋有助於我們改進系統,讓每位使用者都能受益!
如果你沒有找到想使用的現成客戶端,你可以為你自己建立客製化的通知客戶端!
詳見開發文檔。
Littlecatowo 協助翻譯