Skip to content

Latest commit

 

History

History
227 lines (168 loc) · 5.24 KB

CHANGELOG.md

File metadata and controls

227 lines (168 loc) · 5.24 KB

更新摘要 - uv 整合與文檔改進

📅 更新日期

2025年11月27日

🎯 更新目標

將 uv 作為推薦的 Python 套件管理工具整合到專案中，並改進專案文檔結構。

✨ 主要更新內容

1. 新增檔案

📄 文檔檔案

  • QUICKSTART.md - 快速啟動指南

    • 所有專案的快速啟動指令
    • uv 常用指令參考
    • 各專案的啟動方式表格

  • LEARNING_PATH.md - 完整學習路徑

    • 12週完整課程規劃
    • 6週快速上手路徑
    • 專題導向學習路徑
    • 每個章節的詳細說明
    • 學習建議與評量方式

  • scripts/README.md - 腳本使用說明

    • PowerShell 腳本使用方式
    • 執行政策設定說明

🔧 自動化腳本

Windows (PowerShell)

  • scripts/setup-uv.ps1 - 自動安裝 uv
  • scripts/run-flask.ps1 - 快速啟動 Flask 應用
  • scripts/run-jupyter.ps1 - 快速啟動 Jupyter Notebook

Linux/macOS (Bash)

  • scripts/run-flask.sh - Flask 啟動腳本
  • scripts/run-jupyter.sh - Jupyter 啟動腳本

📚 子專案 README

  • 05.Flask/README.md - Flask 專案說明
  • 06.Line-bot-fly-flask/README.md - LINE Bot 專案說明（更新）

2. 更新檔案

📝 README.md (主要更新)

新增內容：

  • 📖 目錄區塊，連結到新文檔
  • 🚀 uv 快速開始章節
    • uv 安裝指令（Windows/macOS/Linux）
    • 一鍵啟動腳本使用說明
    • uv 執行專案的三種方式
    • uv 常用指令參考
  • 🎯 傳統方法重新組織（3選1）
    • venv 方法
    • pipenv 方法
    • 直接使用系統 Python（標註不推薦）
  • 🌟 為什麼推薦 uv 章節
    • 6大優勢說明
    • 速度對比範例
  • 📚 更多資源連結
  • 💬 問題反饋方式

改進內容：

  • 統一程式碼區塊語法（加入 bash 標記）
  • 修正 git clone URL
  • 改善章節結構與排版
  • 加入 emoji 提升可讀性

🚀 新功能特色

一鍵啟動腳本

使用者現在可以用簡單的指令啟動任何專案：

# Windows
.\scripts\run-flask.ps1
.\scripts\run-jupyter.ps1 -Path "11.AI"

# Linux/macOS
./scripts/run-flask.sh
./scripts/run-jupyter.sh "11.AI"

自動環境管理

uv 提供的優勢：

  • ⚡ 比 pip 快 10-100 倍
  • 🎯 自動依賴解析
  • 🔄 跨平台一致性
  • 📦 無需預裝 Python
  • 🛠️ 零配置即可使用

完整學習路徑

提供三種學習路徑：

  1. 12週完整課程（適合初學者）
  2. 6週快速上手（適合有基礎者）
  3. 專題導向學習（依興趣選擇）

📊 文檔結構改進

之前

README.md（包含所有內容，篇幅過長）
各子專案無 README

之後

README.md（主要入口，精簡明瞭）
├── QUICKSTART.md（快速啟動）
├── LEARNING_PATH.md（學習路徑）
├── scripts/
│   ├── README.md（腳本說明）
│   ├── setup-uv.ps1
│   ├── run-flask.ps1
│   ├── run-jupyter.ps1
│   ├── run-flask.sh
│   └── run-jupyter.sh
├── 05.Flask/
│   └── README.md
└── 06.Line-bot-fly-flask/
    └── README.md

💡 使用建議

新使用者

  1. 閱讀 QUICKSTART.md 快速開始
  2. 參考 LEARNING_PATH.md 規劃學習
  3. 使用啟動腳本快速執行範例

現有使用者

  • 可以繼續使用 venv 或 pipenv
  • 建議嘗試 uv 以體驗更快的速度
  • 使用腳本簡化常用操作

教師/講師

  • 使用 LEARNING_PATH.md 作為課程大綱
  • 推薦學生使用啟動腳本減少環境問題
  • 可依據不同課程長度選擇對應的學習路徑

🔄 向後相容性

✅ 完全向後相容

  • 保留所有原有的安裝方式
  • 現有的 requirements.txt 和 Pipfile 仍然有效
  • 不影響已經建立的虛擬環境
  • 所有原有的程式碼無需修改

📈 預期效益

  1. 降低學習門檻

    • 新手可以更快開始學習
    • 減少環境設定問題
    • 一鍵啟動提升體驗

  2. 提升開發效率

    • 套件安裝速度大幅提升
    • 自動化腳本節省時間
    • 統一的開發流程

  3. 改善文檔品質

    • 結構更清晰
    • 內容更豐富
    • 易於維護更新

  4. 增強可訪問性

    • 多種學習路徑選擇
    • 跨平台支援
    • 完整的使用範例

🎓 建議接下來的步驟

使用者

  1. 安裝 uv：.\scripts\setup-uv.ps1 (Windows)
  2. 測試啟動腳本
  3. 選擇適合的學習路徑開始學習

維護者

  1. 測試所有腳本在不同平台的執行
  2. 收集使用者回饋
  3. 根據需求持續改進文檔

📝 版本資訊

  • 版本: 2.0
  • 主要改進: uv 整合、文檔重構
  • 相容性: Python 3.8+
  • 測試平台: Windows 11, macOS, Ubuntu

🙏 致謝

感謝所有對專案提出建議和貢獻的開發者！

📞 聯繫方式

如有任何問題或建議：