readme ai下載 - readme ai源代碼下載

readme ai

其他源碼

v0.1.6

下載

為簡單，自定義和開發人員的生產率而設計。

快速鏈接

概述
演示
特徵
入門
配置
例子
貢獻

重要的

訪問官方文件以獲取詳細的指南和教程。

概述

readme-ai是一種開發工具，它會使用強大的存儲庫處理引擎和高級語言模型自動生成讀數標記文件。只需提供通往代碼庫的URL或路徑，即可生成結構良好的詳細讀數。

為什麼要再讀？

該工具旨在簡化開發人員的文檔流程，節省時間和精力，同時確保高質量的讀數文件。關鍵好處包括：

AI驅動：智能內容生成的利用語言模型。
一致性：確保跨項目的清潔，標準化的文檔。
自定義：量身定制輸出以滿足您的項目要求。
語言不可知論：與大多數編程語言/框架一起使用。
節省時間：在不到一分鐘的時間內生成全面的回教。

演示

從命令行運行：

readmeai-cli-demo.mov

直接在瀏覽器中運行：

readmeai-streamlit-demo.mov

特徵

自動文檔：從您的代碼庫自動生成全面的讀數文件。
可自定義的輸出：量身定製樣式，格式，徽章，標頭設計以及更多偏好。
靈活的後端：與OpenAI ， Ollama ， Anthropic ， Google Gemini無縫集成。
語言不可知論：與廣泛的編程語言和項目類型兼容。
離線模式：在沒有任何外部API調用的情況下，請脫機創建樣板讀數文件。
最佳實踐：確保清潔，專業的文檔，堅持降低最佳實踐。

讓我們看一下readme-ai創建的一些可能的自定義：

pip

針對大多數用戶的推薦方法：

 ❯PIP安裝readmeai

pipx

使用PIPX在孤立的環境中使用readmeai ，確保與其他Python項目沒有依賴性衝突：

 ❯pipx安裝readmeai

紫外線

使用UV使用單個命令安裝readmeai的最快方法：

 ❯紫外線工具安裝readmeai

Docker

要在容器化的環境中運行readmeai ，請從Docker Hub中獲取最新的Docker Image：

 ❯碼頭拉Zeroxeli/readme-ai：最新

來自來源

點擊擴展說明

克隆存儲庫：

 ❯git克隆https://github.com/eli64s/readme-ai

導航到readme-ai目錄：
```
 ❯cd readme-ai
```
安裝依賴項：
```
 ❯PIP安裝-R設置/需求.txt
```

另外，可以使用下面的BASH腳本設置該項目：

bash

運行設置腳本：
```
 ❯bash設置/設置
```

或者，使用poetry來建立該項目：

詩

使用詩歌安裝依賴性：
```
 ❯詩歌安裝
```

重要的

要使用人類和Google Gemini客戶端，需要額外的依賴性。安裝包含以下附加功能的軟件包：

人類：

 ❯PIP安裝“ readmeai [Anthropic]”

Google Gemini：

 ❯PIP安裝“ readmeai [Google-generativeai]”

安裝多個客戶端：

 ❯PIP安裝“ readmeai [擬人，Google-generativeai]”

？運行CLI

1。設置環境變量

與Openai：

 ❯導出OpenAi_Api_key = <your_api_key>＃或Windows用戶：❯設置OpenAi_Api_Key = <your_api_key>

其他提供商（Ollama，Anthropic，Google Gemini）

霍拉馬

有關設置Ollama API的更多信息，請參閱Ollama文檔。這是一個基本示例：

從Ollama存儲庫中獲取您的首選模型：
```
 ❯Ollama拉米斯特拉爾：最新
```
啟動Ollama服務器並設置OLLAMA_HOST環境變量：
```
 ❯導出ollama_host = 127.0.0.1 && ollama服務
```

人類

導出您的擬人API密鑰：

 ❯導出Anthropic_api_key = <your_api_key>

Google雙子座

導出您的Google Gemini API密鑰：

 ❯導出Google_api_key = <your_api_key

2。生成一個讀書文件

運行以下命令，用您自己的存儲庫URL替換：

 ❯readmeai-Repository https://github.com/eli64s/readme-ai-api Openai

重要的

默認情況下，使用gpt-3.5-turbo模型。當更高級模型時，可能會產生較高的成本。

與Ollama一起運行，將llama3設置為模型：

 ❯-readmeai -api ollama -model llama3 -repository https://github.com/eli64s/readme-eadme-ai-

以Anthropic運行：

 ❯-readmeai -api人類-M Claude-3-5-Sonnet-20240620 -r https：//github.com/eli64s/readme-ai-

與Google Gemini一起運行：

 ❯readmeai -api gemini -M gemini-1.5-flash -r https：//github.com/eli64s/readme-eadme-ai

使用local目錄路徑：

 readmeai  -  repository/path/to/your/project

添加更多自定義選項：

 ❯readmeai -repository https://github.com/eli64s/readme-ai
             - 輸出readmeai.md
            -api Openai
             - 模型GPT-4
             -  Badge-Color A931EC
             - 式扁平平方
             - 頭部式緊湊型
             -  toc風格的折疊
             - 溫度0.9
             - 深度2
            - 圖片LLM
             -  emojis

Docker

使用OpenAI客戶端運行Docker容器：

 ❯docker run -it -rm
     -e Openai_api_key = $ openai_api_key
     -v“ $（pwd）”：/app zeroxeli/readme-ai：最新
     -Repository https://github.com/eli64s/readme-ai
     -api Openai

來自來源

點擊擴展說明

bash

如果您使用bash腳本從源安裝了項目，請運行以下命令：

激活虛擬環境：
```
 ❯conda激活readmeai
```

運行CLI：

 ❯python3 -m readmeai.cli.main -r https：//github.com/eli64s/readme-ai

詩

激活虛擬環境：
```
 ❯詩歌外殼
```

運行CLI：

 ❯詩歌運行python3 -m readmeai.cli.main -r https：//github.com/eli64s/readme-eadme-ai

簡化

直接在瀏覽器中直接使用readme-ai，無需安裝。有關更多詳細信息，請參見readme-ai-streamlit存儲庫。

測試

PYTEST和NOX框架用於開發和測試。

使用詩歌安裝依賴項：

 ❯詩歌安裝 - 與開發，測試

使用pytest運行單元測試套件：

 ❯進行測試

使用NOX運行針對Python 3.9、3.10、3.11和3.12的測試套件：

 ❯進行測試諾克斯

提示

_{NOX是一種自動化工具，可在多個Python環境中自動進行測試。它用於確保不同Python版本的兼容性。}

配置

使用以下CLI選項自定義您的自動化信息：

選項	描述	預設
`--align`	標題中的文本對齊	`center`
`--api`	LLM API服務提供商	`offline`
`--badge-color`	徽章顏色名稱或十六進制代碼	`0080ff`
`--badge-style`	徽章圖標樣式類型	`flat`
`--header-style`	標題模板樣式	`classic`
`--toc-style`	目錄樣式	`bullet`
`--emojis`	將表情符號添加到ReadMe標題部分	`False`
`--image`	項目徽標圖像	`blue`
`--model`	使用特定的LLM模型	`gpt-3.5-turbo`
`--output`	輸出文件名	`readme-ai.md`
`--repository`	存儲庫URL或本地目錄路徑	`None`
`--temperature`	內容生成的創造力水平	`0.1`
`--tree-depth`	目錄樹結構的最大深度	`2`

運行以下命令以查看所有可用選項：

 ❯redemeai--螺旋

_{請訪問官方文檔以獲取有關配置選項，示例和最佳實踐的更多詳細信息。}

例子

查看readme-ai在各種技術堆棧中生成的示例readme文件：

技術	示例輸出	存儲庫	描述
readme-ai	readme-ai.md	readme-ai	Readme-AI項目
apache flink	readme-pyflink.md	pyflink-poc	Pyflink項目
簡化	readme-streamlit.md	readme-ai-streamlit	簡化Web應用程序
Vercel＆npm	readme-vercel.md	GitHub-Readme-Quotes	動詞部署
Go＆Docker	readme-docker-go.md	Docker-GS-Ping	Dockerized Go應用程序
Fastapi＆Redis	readme-fastapi-redis.md	異步-ML推導	異步ML推理服務
爪哇	readme-java.md	最小值	極簡主義Todo Java應用程序
Postgresql＆DuckDB	readme-postgres.md	布埃納維斯塔	Postgres代理服務器
科特林	readme-kotlin.md	Android-Client	Android客戶端應用程序
離線模式	離線mode.md	Litellm	LLM API服務