Wendong-Fan commited on
Commit
268015d
·
1 Parent(s): e21a39d

update readme for more install optionals

Browse files
Files changed (3) hide show
  1. README.md +50 -0
  2. README_zh.md +52 -4
  3. requirements.txt +4 -0
README.md CHANGED
@@ -104,6 +104,8 @@ https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-13
104
 
105
  # 🛠️ Installation
106
 
 
 
107
  ```bash
108
  # Clone github repo
109
  git clone https://github.com/camel-ai/owl.git
@@ -131,6 +133,54 @@ uv pip install -e .
131
  deactivate
132
  ```
133
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
134
  ## **Setup Environment Variables**
135
 
136
  In the `owl/.env_template` file, you will find all the necessary API keys along with the websites where you can register for each service. To use these API services, follow these steps:
 
104
 
105
  # 🛠️ Installation
106
 
107
+ ## Option 1: Using uv (Recommended)
108
+
109
  ```bash
110
  # Clone github repo
111
  git clone https://github.com/camel-ai/owl.git
 
133
  deactivate
134
  ```
135
 
136
+ ## Option 2: Using venv and pip
137
+
138
+ ```bash
139
+ # Clone github repo
140
+ git clone https://github.com/camel-ai/owl.git
141
+
142
+ # Change directory into project directory
143
+ cd owl
144
+
145
+ # Create a virtual environment
146
+ # For Python 3.10 (also works with 3.11, 3.12)
147
+ python3.10 -m venv .venv
148
+
149
+ # Activate the virtual environment
150
+ # For macOS/Linux
151
+ source .venv/bin/activate
152
+ # For Windows
153
+ .venv\Scripts\activate
154
+
155
+ # Install from requirements.txt
156
+ pip install -r requirements.txt
157
+ ```
158
+
159
+ ## Option 3: Using conda
160
+
161
+ ```bash
162
+ # Clone github repo
163
+ git clone https://github.com/camel-ai/owl.git
164
+
165
+ # Change directory into project directory
166
+ cd owl
167
+
168
+ # Create a conda environment
169
+ conda create -n owl python=3.10
170
+
171
+ # Activate the conda environment
172
+ conda activate owl
173
+
174
+ # Option 1: Install as a package (recommended)
175
+ pip install -e .
176
+
177
+ # Option 2: Install from requirements.txt
178
+ pip install -r requirements.txt
179
+
180
+ # Exit the conda environment when done
181
+ conda deactivate
182
+ ```
183
+
184
  ## **Setup Environment Variables**
185
 
186
  In the `owl/.env_template` file, you will find all the necessary API keys along with the websites where you can register for each service. To use these API services, follow these steps:
README_zh.md CHANGED
@@ -67,9 +67,9 @@
67
  - [🎬 演示视频](#-演示视频)
68
  - [✨️ 核心功能](#-核心功能)
69
  - [🛠️ 安装](#️-安装)
70
- - [**克隆 Github 仓库**](#克隆-github-仓库)
71
- - [**设置环境**](#设置环境)
72
- - [**安装依赖**](#安装依赖)
73
  - [**设置环境变量**](#设置环境变量)
74
  - [**使用Docker运行**](#使用docker运行)
75
  - [🚀 快速开始](#-快速开始)
@@ -103,7 +103,7 @@ https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-13
103
 
104
  # 🛠️ 安装
105
 
106
- ## **克隆 Github 仓库**
107
 
108
  ```bash
109
  # 克隆 GitHub 仓库
@@ -132,6 +132,54 @@ uv pip install -e .
132
  deactivate
133
  ```
134
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
135
  ## **设置环境变量**
136
 
137
  在 `owl/.env_template` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作:
 
67
  - [🎬 演示视频](#-演示视频)
68
  - [✨️ 核心功能](#-核心功能)
69
  - [🛠️ 安装](#️-安装)
70
+ - [**选项1:使用 uv(推荐)**](#选项1使用-uv推荐)
71
+ - [**选项2:使用 venv 和 pip**](#选项2使用-venv-和-pip)
72
+ - [**选项3:使用 conda**](#选项3使用-conda)
73
  - [**设置环境变量**](#设置环境变量)
74
  - [**使用Docker运行**](#使用docker运行)
75
  - [🚀 快速开始](#-快速开始)
 
103
 
104
  # 🛠️ 安装
105
 
106
+ ## 选项1:使用 uv(推荐)
107
 
108
  ```bash
109
  # 克隆 GitHub 仓库
 
132
  deactivate
133
  ```
134
 
135
+ ## 选项2:使用 venv 和 pip
136
+
137
+ ```bash
138
+ # 克隆 GitHub 仓库
139
+ git clone https://github.com/camel-ai/owl.git
140
+
141
+ # 进入项目目录
142
+ cd owl
143
+
144
+ # 创建虚拟环境
145
+ # 对于 Python 3.10(也适用于 3.11、3.12)
146
+ python3.10 -m venv .venv
147
+
148
+ # 激活虚拟环境
149
+ # 对于 macOS/Linux
150
+ source .venv/bin/activate
151
+ # 对于 Windows
152
+ .venv\Scripts\activate
153
+
154
+ # 从 requirements.txt 安装
155
+ pip install -r requirements.txt
156
+ ```
157
+
158
+ ## 选项3:使用 conda
159
+
160
+ ```bash
161
+ # 克隆 GitHub 仓库
162
+ git clone https://github.com/camel-ai/owl.git
163
+
164
+ # 进入项目目录
165
+ cd owl
166
+
167
+ # 创建 conda 环境
168
+ conda create -n owl python=3.10
169
+
170
+ # 激活 conda 环境
171
+ conda activate owl
172
+
173
+ # 选项1:作为包安装(推荐)
174
+ pip install -e .
175
+
176
+ # 选项2:从 requirements.txt 安装
177
+ pip install -r requirements.txt
178
+
179
+ # 完成后退出 conda 环境
180
+ conda deactivate
181
+ ```
182
+
183
  ## **设置环境变量**
184
 
185
  在 `owl/.env_template` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作:
requirements.txt ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ camel-ai[all]==0.2.23
2
+ chunkr-ai>=0.0.41
3
+ docx2markdown>=0.1.1
4
+ gradio>=3.50.2