rhul-attendance-bot 0.1.48__tar.gz

rhul_attendance_bot-0.1.48/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+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, 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.
+
+[Additional Clause]
+For any commercial use, attribution to the original author (PandaQuQ) is required.
+
+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.

rhul_attendance_bot-0.1.48/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include README_CN.md
+include LICENSE
+recursive-include assets *.png *.jpg *.jpeg *.gif
+exclude credentials.json
+exclude 2fa_config.json
+exclude automation.log
+recursive-exclude chrome_user_data *
+recursive-exclude ics *
+global-exclude *.pyc

rhul_attendance_bot-0.1.48/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: rhul-attendance-bot
+Version: 0.1.48
+Summary: RHUL attendance automation bot
+Author: PandaQuQ
+License: 
+        MIT License
+        
+        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, 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.
+        
+        [Additional Clause]
+        For any commercial use, attribution to the original author (PandaQuQ) is required.
+        
+        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.
+        
+Project-URL: Repository, https://github.com/PandaQuQ/RHUL_attendance_bot
+Keywords: automation,attendance,selenium,rhul
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ics
+Requires-Dist: rich
+Requires-Dist: selenium
+Requires-Dist: webdriver-manager
+Requires-Dist: pynput
+Requires-Dist: ntplib
+Requires-Dist: pyotp
+Dynamic: license-file
+
+# RHUL Attendance Bot
+[中文](https://github.com/PandaQuQ/RHUL_attendance_bot/blob/main/README_CN.md)
+---
+![Python](https://img.shields.io/badge/Python-3.9%2B-blue)
+![License](https://img.shields.io/badge/License-MIT-green)
+![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey)
+![Version No.](https://img.shields.io/github/commits-since/PandaQuQ/RHUL_attendance_bot/b80f0cf6c4b060ebf318bff844607af06225e6b0?label=Version%20No.)
+![Last Updated](https://img.shields.io/github/last-commit/PandaQuQ/RHUL_attendance_bot)
+
+The RHUL Attendance Bot automates attendance marking for Royal Holloway students by using web automation. The script checks your calendar events, triggers attendance based on specified conditions, and provides real-time logging using Rich library for better visualization.
+![UI screenshot](assets/ui_screenshot.png)
+![Discord broadcast screenshot](assets/discord_bot_screenshot.png)
+## Features
+
+- **Automated Attendance**: Automatically opens the attendance page and marks your attendance based on your calendar events.
+- **Manual Trigger**: Allows manual attendance marking via keyboard shortcuts.
+- **Real-Time Logging**: Displays logs using Rich library for a better visual experience.
+- **Environment and Dependency Checks**: Ensures the script is run in the proper environment and all dependencies are installed.
+- **System Time Synchronization Check**: Checks if the system time is synchronized with the NTP server.
+- **Auto-Update Feature**: Detects script updates and prompts the user to update.
+- **Auto Login with 2FA**: Handles Microsoft login, switches to verification code, and auto-fills TOTP from your saved secret.
+- **Automatic Timetable Download**: On first run, automatically fetches your ICS timetable into the `ics/` folder—no manual download needed.
+- **Discord Webhook Notifications (optional)**: Sends start/stop, login success, and attendance success messages with your profile name when a webhook URL is configured.
+
+## Prerequisites
+
+1. **Python 3.9 or above**: Ensure that Python is installed. If not, download and install it from [python.org](https://www.python.org/downloads/).
+2. **Google Chrome Browser**: The script uses Chrome for web automation. Make sure it is installed.
+3. **Virtual Environment (Recommended)**: Run the script inside a Python virtual environment to avoid dependency conflicts.
+
+## Installation
+
+Install Google Chrome if you don't have it yet: [download page](https://www.google.com/chrome/) (macOS users can also `brew install --cask google-chrome`).
+
+### Step 1: Clone the Repository
+
+```bash
+git clone https://github.com/PandaQuQ/RHUL_attendance_bot.git
+```
+
+### Step 2: Navigate to the Project Directory
+
+```bash
+cd RHUL_attendance_bot
+```
+
+### Step 3: Set Up a Virtual Environment (Recommended)
+
+#### On Windows:
+```bash
+python -m venv venv
+venv\Scripts\activate
+```
+
+#### On macOS/Linux:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+### Step 4: Install Dependencies
+
+#### Option A: Install from PyPI (recommended)
+
+```bash
+pip install rhul-attendance-bot
+```
+
+#### Option B: Install from source
+
+```bash
+pip install -r requirements.txt
+```
+
+### Step 5: (Optional) Prepare ICS Manually
+
+The bot now auto-downloads your timetable on first run and stores it in `ics/`. You only need manual prep if the auto download fails:
+
+- Go to [Royal Holloway Timetable](https://intranet.royalholloway.ac.uk/students/study/timetable/your-timetable.aspx) and log in.
+- Choose `Calendar Download`, click `View Timetable`, then `Android™ and others` to get the `.ics` link.
+- Download the `.ics` and place it into the `ics` folder at the project root (create it if missing).
+
+## Usage
+
+1. **Navigate to the Script Directory**:
+
+   ```bash
+   cd RHUL_attendance_bot
+   ```
+
+2. **Activate the Virtual Environment**:
+
+   #### On Windows:
+   ```bash
+   venv\Scripts\activate
+   ```
+
+   #### On macOS/Linux:
+   ```bash
+   source venv/bin/activate
+   ```
+
+3. **Run the Script**:
+
+   #### From PyPI install:
+   ```bash
+   rhul-attendance-bot
+   ```
+
+   #### From source:
+   ```bash
+   python RHUL_attendance_bot.py
+   ```
+
+   > **✅ Auto Login + 2FA**
+   > 
+   > The bot now handles Microsoft login and the verification-code MFA flow automatically using your stored credentials and local TOTP secret. On first run, complete onboarding (credentials/secret); the timetable is downloaded automatically.
+
+4. **Profile Selection**:
+
+    - Use `-user <profile_name>` to pick a specific profile, e.g.:
+       ```bash
+       rhul-attendance-bot -user Alice
+       ```
+    - If `-user` is not provided, the app will list existing profiles and ask you to choose (or create a new one).
+
+5. **Keyboard Shortcuts**:
+
+   - **Manually Trigger the Next Event**: Press `[`, then `]`
+   - **Exit the Script**: Press `[`, then `q`
+
+## Important Notes
+
+- **Dependencies**: Make sure all required dependencies are installed by following the instructions in the `requirements.txt` file.
+- **Virtual Environment**: Using a virtual environment is highly recommended to avoid conflicts with global packages.
+- **System Time**: If the system time is not synchronized with the NTP server, the script will prompt you to synchronize your system clock.
+- **Supported Platforms**: The script supports Windows, macOS, and Linux.
+
+### Multi-Profile Usage
+
+Profiles are stored under `~/.rhul_attendance_bot/profiles/<profile_name>`. Each profile has its own:
+
+- `credentials.json`
+- `2fa_config.json`
+- `ics/`
+- `chrome_user_data/`
+- `automation.log`
+
+Use `-user` to switch profiles at runtime.
+
+> **🔐 Security Note - Login Session Duration**
+> 
+> ~~A session typically lasts about one week; you may need to manually re-login after it expires.~~
+> The bot now auto-renews login with stored credentials + TOTP. Sessions are refreshed automatically; monitor occasionally in case the institution changes its 2FA policy.
+
+## Configuration
+
+To configure the script, modify the relevant parameters inside the code or create a configuration file (not provided in this version). Future versions may include more flexible configuration options.
+
+## Updating
+
+If an update is detected, the script will prompt you to update. You can choose to update by typing `y` or skip it by typing `n`.
+
+## Troubleshooting
+
+1. **Chrome WebDriver Issues**: Make sure that the correct version of the ChromeDriver is being used. The script uses `webdriver-manager` to automatically manage ChromeDriver versions.
+2. **Dependency Issues**: If you encounter errors related to missing modules, reinstall via `pip install rhul-attendance-bot` or use `pip install -r requirements.txt` from source.
+3. **Virtual Environment Issues**: If you face issues while running the script, try setting up a fresh virtual environment and reinstalling the dependencies.
+
+## TODO
+
+Current focus / future ideas:
+
+- ✅ **2FA Integration**: Microsoft verification-code path with TOTP auto-fill is implemented.
+- ✅ **Automatic Login**: Stored credentials + TOTP drive a fully automatic login flow.
+- ✅ **2FA Code Reading**: OTP is generated locally from your saved secret.
+- ✅ **Discord Webhook Bot**: Discord webhook notifications for attendance status, login, and lifecycle (optional; disable by leaving webhook URL empty)
+
+## License
+
+This project is licensed under the MIT License with an additional clause. See the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Thanks to the developers of [Rich](https://github.com/Textualize/rich), [Selenium](https://www.selenium.dev/), and [ics.py](https://github.com/C4ptainCrunch/ics.py) for their amazing libraries.
+
+## Contact
+
+For questions or suggestions, please feel free to reach out via the [GitHub repository](https://github.com/PandaQuQ/RHUL_attendance_bot). Feedback and contributions are welcome!

rhul_attendance_bot-0.1.48/README.md

@@ -0,0 +1,189 @@
+# RHUL Attendance Bot
+[中文](https://github.com/PandaQuQ/RHUL_attendance_bot/blob/main/README_CN.md)
+---
+![Python](https://img.shields.io/badge/Python-3.9%2B-blue)
+![License](https://img.shields.io/badge/License-MIT-green)
+![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey)
+![Version No.](https://img.shields.io/github/commits-since/PandaQuQ/RHUL_attendance_bot/b80f0cf6c4b060ebf318bff844607af06225e6b0?label=Version%20No.)
+![Last Updated](https://img.shields.io/github/last-commit/PandaQuQ/RHUL_attendance_bot)
+
+The RHUL Attendance Bot automates attendance marking for Royal Holloway students by using web automation. The script checks your calendar events, triggers attendance based on specified conditions, and provides real-time logging using Rich library for better visualization.
+![UI screenshot](assets/ui_screenshot.png)
+![Discord broadcast screenshot](assets/discord_bot_screenshot.png)
+## Features
+
+- **Automated Attendance**: Automatically opens the attendance page and marks your attendance based on your calendar events.
+- **Manual Trigger**: Allows manual attendance marking via keyboard shortcuts.
+- **Real-Time Logging**: Displays logs using Rich library for a better visual experience.
+- **Environment and Dependency Checks**: Ensures the script is run in the proper environment and all dependencies are installed.
+- **System Time Synchronization Check**: Checks if the system time is synchronized with the NTP server.
+- **Auto-Update Feature**: Detects script updates and prompts the user to update.
+- **Auto Login with 2FA**: Handles Microsoft login, switches to verification code, and auto-fills TOTP from your saved secret.
+- **Automatic Timetable Download**: On first run, automatically fetches your ICS timetable into the `ics/` folder—no manual download needed.
+- **Discord Webhook Notifications (optional)**: Sends start/stop, login success, and attendance success messages with your profile name when a webhook URL is configured.
+
+## Prerequisites
+
+1. **Python 3.9 or above**: Ensure that Python is installed. If not, download and install it from [python.org](https://www.python.org/downloads/).
+2. **Google Chrome Browser**: The script uses Chrome for web automation. Make sure it is installed.
+3. **Virtual Environment (Recommended)**: Run the script inside a Python virtual environment to avoid dependency conflicts.
+
+## Installation
+
+Install Google Chrome if you don't have it yet: [download page](https://www.google.com/chrome/) (macOS users can also `brew install --cask google-chrome`).
+
+### Step 1: Clone the Repository
+
+```bash
+git clone https://github.com/PandaQuQ/RHUL_attendance_bot.git
+```
+
+### Step 2: Navigate to the Project Directory
+
+```bash
+cd RHUL_attendance_bot
+```
+
+### Step 3: Set Up a Virtual Environment (Recommended)
+
+#### On Windows:
+```bash
+python -m venv venv
+venv\Scripts\activate
+```
+
+#### On macOS/Linux:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+### Step 4: Install Dependencies
+
+#### Option A: Install from PyPI (recommended)
+
+```bash
+pip install rhul-attendance-bot
+```
+
+#### Option B: Install from source
+
+```bash
+pip install -r requirements.txt
+```
+
+### Step 5: (Optional) Prepare ICS Manually
+
+The bot now auto-downloads your timetable on first run and stores it in `ics/`. You only need manual prep if the auto download fails:
+
+- Go to [Royal Holloway Timetable](https://intranet.royalholloway.ac.uk/students/study/timetable/your-timetable.aspx) and log in.
+- Choose `Calendar Download`, click `View Timetable`, then `Android™ and others` to get the `.ics` link.
+- Download the `.ics` and place it into the `ics` folder at the project root (create it if missing).
+
+## Usage
+
+1. **Navigate to the Script Directory**:
+
+   ```bash
+   cd RHUL_attendance_bot
+   ```
+
+2. **Activate the Virtual Environment**:
+
+   #### On Windows:
+   ```bash
+   venv\Scripts\activate
+   ```
+
+   #### On macOS/Linux:
+   ```bash
+   source venv/bin/activate
+   ```
+
+3. **Run the Script**:
+
+   #### From PyPI install:
+   ```bash
+   rhul-attendance-bot
+   ```
+
+   #### From source:
+   ```bash
+   python RHUL_attendance_bot.py
+   ```
+
+   > **✅ Auto Login + 2FA**
+   > 
+   > The bot now handles Microsoft login and the verification-code MFA flow automatically using your stored credentials and local TOTP secret. On first run, complete onboarding (credentials/secret); the timetable is downloaded automatically.
+
+4. **Profile Selection**:
+
+    - Use `-user <profile_name>` to pick a specific profile, e.g.:
+       ```bash
+       rhul-attendance-bot -user Alice
+       ```
+    - If `-user` is not provided, the app will list existing profiles and ask you to choose (or create a new one).
+
+5. **Keyboard Shortcuts**:
+
+   - **Manually Trigger the Next Event**: Press `[`, then `]`
+   - **Exit the Script**: Press `[`, then `q`
+
+## Important Notes
+
+- **Dependencies**: Make sure all required dependencies are installed by following the instructions in the `requirements.txt` file.
+- **Virtual Environment**: Using a virtual environment is highly recommended to avoid conflicts with global packages.
+- **System Time**: If the system time is not synchronized with the NTP server, the script will prompt you to synchronize your system clock.
+- **Supported Platforms**: The script supports Windows, macOS, and Linux.
+
+### Multi-Profile Usage
+
+Profiles are stored under `~/.rhul_attendance_bot/profiles/<profile_name>`. Each profile has its own:
+
+- `credentials.json`
+- `2fa_config.json`
+- `ics/`
+- `chrome_user_data/`
+- `automation.log`
+
+Use `-user` to switch profiles at runtime.
+
+> **🔐 Security Note - Login Session Duration**
+> 
+> ~~A session typically lasts about one week; you may need to manually re-login after it expires.~~
+> The bot now auto-renews login with stored credentials + TOTP. Sessions are refreshed automatically; monitor occasionally in case the institution changes its 2FA policy.
+
+## Configuration
+
+To configure the script, modify the relevant parameters inside the code or create a configuration file (not provided in this version). Future versions may include more flexible configuration options.
+
+## Updating
+
+If an update is detected, the script will prompt you to update. You can choose to update by typing `y` or skip it by typing `n`.
+
+## Troubleshooting
+
+1. **Chrome WebDriver Issues**: Make sure that the correct version of the ChromeDriver is being used. The script uses `webdriver-manager` to automatically manage ChromeDriver versions.
+2. **Dependency Issues**: If you encounter errors related to missing modules, reinstall via `pip install rhul-attendance-bot` or use `pip install -r requirements.txt` from source.
+3. **Virtual Environment Issues**: If you face issues while running the script, try setting up a fresh virtual environment and reinstalling the dependencies.
+
+## TODO
+
+Current focus / future ideas:
+
+- ✅ **2FA Integration**: Microsoft verification-code path with TOTP auto-fill is implemented.
+- ✅ **Automatic Login**: Stored credentials + TOTP drive a fully automatic login flow.
+- ✅ **2FA Code Reading**: OTP is generated locally from your saved secret.
+- ✅ **Discord Webhook Bot**: Discord webhook notifications for attendance status, login, and lifecycle (optional; disable by leaving webhook URL empty)
+
+## License
+
+This project is licensed under the MIT License with an additional clause. See the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Thanks to the developers of [Rich](https://github.com/Textualize/rich), [Selenium](https://www.selenium.dev/), and [ics.py](https://github.com/C4ptainCrunch/ics.py) for their amazing libraries.
+
+## Contact
+
+For questions or suggestions, please feel free to reach out via the [GitHub repository](https://github.com/PandaQuQ/RHUL_attendance_bot). Feedback and contributions are welcome!

rhul_attendance_bot-0.1.48/README_CN.md

@@ -0,0 +1,189 @@
+# RHUL 自动签到脚本
+[English](https://github.com/PandaQuQ/RHUL_attendance_bot/blob/main/README.md)
+---
+![Python](https://img.shields.io/badge/Python-3.9%2B-blue)
+![License](https://img.shields.io/badge/License-MIT-green)
+![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey)
+![Version No.](https://img.shields.io/github/commits-since/PandaQuQ/RHUL_attendance_bot/b80f0cf6c4b060ebf318bff844607af06225e6b0?label=Version%20No.)
+![Last Updated](https://img.shields.io/github/last-commit/PandaQuQ/RHUL_attendance_bot)
+
+RHUL 自动签到脚本通过使用网页自动化来为 Royal Holloway 学生自动签到。该脚本根据日历事件检查并触发签到操作，并使用 Rich 库进行实时日志记录，提供更好的可视化体验。
+![UI screenshot](assets/ui_screenshot.png)
+![Discord broadcast screenshot](assets/discord_bot_screenshot.png)
+## 功能
+
+- **自动签到**：根据日历事件自动打开签到页面并进行签到。
+- **手动触发**：允许通过快捷键手动触发签到操作。
+- **实时日志记录**：使用 Rich 库显示日志，提供更好的视觉效果。
+- **环境和依赖检查**：确保脚本在正确的环境中运行并安装了所有依赖项。
+- **系统时间同步检查**：检查系统时间是否与 NTP 服务器同步。
+- **自动更新功能**：检测脚本更新并提示用户更新。
+- **自动登录 + 2FA**：自动处理微软登录，选择“验证码”方式，并用本地保存的 TOTP 秘钥自动填充验证码。
+- **自动下载课表**：首次运行自动下载课表到 `ics/` 目录，无需手动获取 `.ics` 文件。
+- **Discord Webhook 通知（可选）**：配置 Webhook 后推送启动/停止、登录成功、签到成功等消息，并附带个人昵称。
+
+## 前提条件
+
+1. **Python 3.9 或以上**：确保已安装 Python。如果没有，请从 [python.org](https://www.python.org/downloads/) 下载并安装。
+2. **Google Chrome 浏览器**：脚本使用 Chrome 进行网页自动化，请确保已安装 Chrome 浏览器。
+3. **虚拟环境（推荐）**：在 Python 虚拟环境中运行脚本以避免依赖冲突。
+
+## 安装
+
+在安装前请先确保已安装 Google Chrome：可前往 [下载页面](https://www.google.com/chrome/)（macOS 也可使用 `brew install --cask google-chrome`）。
+
+### 步骤 1：克隆代码仓库
+
+```bash
+git clone https://github.com/PandaQuQ/RHUL_attendance_bot.git
+```
+
+### 步骤 2：进入项目目录
+
+```bash
+cd RHUL_attendance_bot
+```
+
+### 步骤 3：设置虚拟环境（推荐）
+
+#### Windows 系统：
+```bash
+python -m venv venv
+venv\Scripts\activate
+```
+
+#### macOS/Linux 系统：
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+### 步骤 4：安装依赖项
+
+#### 方式 A：通过 PyPI 安装（推荐）
+
+```bash
+pip install rhul-attendance-bot
+```
+
+#### 方式 B：从源码安装
+
+```bash
+pip install -r requirements.txt
+```
+
+### 步骤 5：（可选）手动准备课表
+
+脚本现已在首次运行时自动下载课表到 `ics/`。仅当自动下载失败时，才需要手动准备：
+
+- 访问 [Royal Holloway 课表系统](https://intranet.royalholloway.ac.uk/students/study/timetable/your-timetable.aspx) 并登录。
+- 选择 `Calendar Download`，点击 `View Timetable`，然后点击 `Android™ and others` 获取 `.ics` 链接。
+- 下载 `.ics` 文件，并放入项目根目录的 `ics` 文件夹（如无则新建）。
+
+## 使用说明
+
+1. **进入脚本根目录**：
+
+   ```bash
+   cd RHUL_attendance_bot
+   ```
+
+2. **激活虚拟环境**：
+
+   #### Windows 系统：
+   ```bash
+   venv\Scripts\activate
+   ```
+
+   #### macOS/Linux 系统：
+   ```bash
+   source venv/bin/activate
+   ```
+
+3. **运行脚本**：
+
+   #### PyPI 安装：
+   ```bash
+   rhul-attendance-bot
+   ```
+
+   #### 源码运行：
+   ```bash
+   python RHUL_attendance_bot.py
+   ```
+
+   > **✅ 自动登录 + 2FA 已完成**
+   > 
+   > 现在脚本会自动处理微软登录和“验证码” MFA 流程，使用已保存的账号、密码和本地 TOTP 秘钥生成验证码。首次运行按引导完成账号/秘钥绑定；课表将自动下载。
+
+4. **Profile 选择**：
+
+    - 用 `-user <profile_name>` 指定 Profile，例如：
+       ```bash
+       rhul-attendance-bot -user 用户1
+       ```
+    - 不传 `-user` 会列出已有 Profile 并让你选择/创建。
+
+5. **快捷键说明**：
+
+   - **手动触发下一个事件**：按下 `[` 然后按 `]`
+   - **退出脚本**：按下 `[` 然后按 `q`
+
+## 注意事项
+
+- **依赖项**：确保已根据 `requirements.txt` 文件的说明安装所有必需的依赖项。
+- **虚拟环境**：强烈建议使用虚拟环境，以避免与全局包产生冲突。
+- **系统时间**：如果系统时间与 NTP 服务器不同步，脚本会提示您同步系统时钟。
+- **支持平台**：脚本支持 Windows、macOS 和 Linux 系统。
+
+### 多 Profile 使用
+
+Profile 数据存放在 `~/.rhul_attendance_bot/profiles/<profile_name>` 下，每个 Profile 独立保存：
+
+- `credentials.json`
+- `2fa_config.json`
+- `ics/`
+- `chrome_user_data/`
+- `automation.log`
+
+运行时用 `-user` 切换 Profile。
+
+> **🔐 安全提示 - 登录会话时长**
+> 
+> ~~一次登录周期大约为一周，过期可能需要手动重新登录。~~
+> 现在已支持使用存储的账号 + TOTP 自动续期登录。会话会自动刷新；如学校调整 2FA 策略，请偶尔检查运行状态。
+
+## 配置
+
+要配置脚本，可以修改代码中的相关参数，或者创建配置文件（当前版本不提供）。未来版本可能会增加更灵活的配置选项。
+
+## 更新
+
+如果检测到更新，脚本会提示您是否更新。可以输入 `y` 更新，也可以输入 `n` 跳过更新。
+
+## 常见问题
+
+1. **Chrome WebDriver 问题**：确保使用的是正确版本的 ChromeDriver。脚本使用 `webdriver-manager` 自动管理 ChromeDriver 版本。
+2. **依赖问题**：如果遇到缺少模块的错误，请使用 `pip install rhul-attendance-bot` 或从源码执行 `pip install -r requirements.txt`。
+3. **虚拟环境问题**：如果运行脚本时出现问题，请尝试重新设置虚拟环境并重新安装依赖项。
+
+## TODO
+
+当前进展 / 后续想法：
+
+- ✅ **集成 2FA**：已实现微软验证码通道，自动填充 TOTP。
+- ✅ **读取 2FA 验证码**：使用本地秘钥生成 OTP 并自动填写。
+- ✅ **自动登录**：已实现全自动登录流程。
+- ✅ **Discord Hook Bot**：已支持 Discord Webhook 通知（可选，Webhook 置空即禁用），推送签到状态、登录和生命周期事件
+
+## 许可证
+
+本项目采用 MIT 许可证并附加额外条款。有关详细信息，请参阅 [LICENSE](LICENSE) 文件。
+
+## 鸣谢
+
+- 感谢 [Rich](https://github.com/Textualize/rich)、[Selenium](https://www.selenium.dev/) 和 [ics.py](https://github.com/C4ptainCrunch/ics.py) 库的开发者。
+
+## 联系方式
+
+如有问题或建议，请通过 [GitHub 仓库](https://github.com/PandaQuQ/RHUL_attendance_bot) 联系我。欢迎反馈和贡献！