auto-doc-gen 0.1.0

自動產生 README、.gitignore 與 requirements.txt 的 CLI 工具

My Project

📘 專案介紹

「My Project」是一個高度專業且易於使用的專案，具有以下優越之處：

1. 強大的功能： My Project 提供一系列強大而多功能的工具，能夠滿足不同級別的使用者需求。

2. 易於使用： My Project 設計簡單明了，操作方便。無論是初學者還是經驗豐富的使用者，都能夠快速了解並開始使用。

3. 安全可靠： My Project 放滿了資料保護和網絡安全的功能，能確保你的資料永遠安全。

4. 高效率： My Project 幫助您更快速高效地進行工作，提升您的生產力和效率。

5. 多語言支持： My Project 支持多種語言，使用者可以根據自己的需求選擇所需語言。

6. 免費且具有完整功能： My Project 隨著下載即提供完全功能，而無需任何付款或償费。

7. 持續更新： My Project 团队不斷地優化和更新其產品，以提供最佳使用體驗。

8. 優秀的客戶服務： My Project 提供豐富的客戶支援服務，包括在線聊天、電子郵件等多種方式，以確保您的問題能夠得到有效解答。

My Project 是一個完全免費且高度專業的專案，旨在提供強大而易於使用的工具，讓你的生產力和效率更高。請來試驗一下我們的產品，開始享受您自己的經驗吧！

🛠 安裝方式

以下為 Python 專案的中文安裝說明：

先決條件： 本專案建議使用版本為Python 3.6 或更新版本的Python語言。您可以前往 https://www.python.org/downloads/ 下載最新版本的Python。

安裝步驟：

1. 將專案 clone 到您的電腦上，如果尚未 clone，請使用以下指令：

git clone https://github.com/your_username/your_project.git

2. 進入專案根目錄，Activate（或 Source）您的虛擬環境，如果尚未建立，請參考以下指令：

• Windows:

python -m venv env
.\env\Scripts\activate

• Linux/MacOS:

python3 -m venv env
source env/bin/activate

3. 安裝專案需要的所有相依套件，請使用以下指令：

pip install -r requirements.txt

4. 您現在就可以執行程式了，只需要執行主要的python文件即可：

python main.py

5. (可選項) 如果您想搭配Docker執行專案，請先安裝Docker及Docker Compose，然後進入docker目錄下，使用以下指令啟動：

docker-compose up

這樣即可成功安裝並執行專案了！如果您遇到問題，請查閱 README.md 或者提出 Issue。

🚀 使用方法

1. 環境準備與工具安裝：

（A）安裝 Python 3.x: Python 是此專案的基本要求。如果您尚未安裝，請參考以下指示安裝：

# 檢查目前已安裝的 Python 版本
python --version

# 安裝 Python 3.x (例如：Python 3.8)
wget https://www.python.org/ftp/python/3.8.5/Python-3.8.5-macosx10.9.pkg
sudo installer -pkg Python-3.8.5-macosx10.9.pkg -target /

（B）安裝 pip (Python 套件管理工具)： pip 是用於安裝和管理 Python 套件的工具，您可以使用以下命令安裝它：

# 檢查目前已安裝的 pip 版本
pip --version

# 如果尚未安裝，請安裝 pip
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py

（C）安裝 virtualenv (虛擬環境)： virtualenv 可以創建隔離的 Python 環境，防止套件版本衝突。請使用以下命令安裝：

# 安裝 virtualenv
pip install virtualenv

**（D）克隆 GitHub 儲存庫 (例如：git clone https://github.com/username/project-name.git)**： 克隆此專案的 GitHub 儲存庫，將其下載至您的電腦。

2. 專案使用指令：

（A）建立虛擬環境 (virtualenv)：

# 進入專案目錄
cd project-name

# 建立名為 'venv' 的虛擬環境
virtualenv venv

（B）啟動虛擬環境 (source)：

# 啟動創建好的虛擬環境
source venv/bin/activate

（注意：在使用 activate 命令時，請務必將虛擬環境路徑改為您自己創建的虛擬環境。） （C）安裝專案需要的套件 (pip install)：

# 從 requirements.txt 檔案中安裝所有套件
pip install -r requirements.txt

（D）啟動專案（例如，執行一個名為 app.py 的 Python 腳本）：

# 執行專案，此處以 python app.py 為例
python app.py

（E）自動生成 README.md、.gitignore 或 requirements.txt: 此專案提供了自動化工具，可以自動產生這些文件。您可以執行以下命令：

# 在 GitHub 上建立專案後，安裝一個名為 mkdocs 的工具 (如果尚未安裝)
pip install mkdocs

# 執行 auto-scripts/generate_files.sh 腳本，自動產生 README、.gitignore 或 requirements.txt。
bash auto-scripts/generate_files.sh

📦 專案模組說明

• requirements.txt：自動產生相依套件清單
• auto_doc_gen.egg-info/SOURCES.txt：其他功能模組
• auto_doc_gen.egg-info/entry_points.txt：其他功能模組
• auto_doc_gen.egg-info/requires.txt：其他功能模組
• auto_doc_gen.egg-info/top_level.txt：其他功能模組
• auto_doc_gen.egg-info/dependency_links.txt：其他功能模組
• README.md：自動產生專案的 README 說明文件
• .pytest_cache/README.md：自動產生專案的 README 說明文件
• setup.py：其他功能模組
• main.py：專案 CLI 主執行檔，啟動整體邏輯
• core/gpt_summarizer.py：其他功能模組
• core/requirements_generator.py：自動產生相依套件清單
• core/project_scanner.py：掃描專案資料夾與檔案資訊
• core/config.py：其他功能模組
• core/readme_generator.py：自動產生專案的 README 說明文件
• core/content_filter.py：過濾與清理不應公開的敏感資訊
• core/ollama_summarizer.py：其他功能模組
• core/gitignore_generator.py：根據語言與專案自動產出 .gitignore
• tests/test_filter.py：過濾與清理不應公開的敏感資訊
• tests/gpt_key_test.py：其他功能模組
• utils/file_scanner.py：掃描專案資料夾與檔案資訊
• .pytest_cache/CACHEDIR.TAG：其他功能模組
• .pytest_cache/v/cache/nodeids：其他功能模組
• .pytest_cache/v/cache/lastfailed：其他功能模組
• auto_doc_gen.egg-info/PKG-INFO：其他功能模組

🧰 使用技術

• 使用語言：Python
• 工具與框架：pip, pytest