-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
83 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
## 开发 | ||
|
||
本项目包含 lab 目录下的 libro-lab 前端工程和 libro-server、libro-ai 两个 python 包,分别在 libro-server 和 libro-ai 目录下。 | ||
|
||
### 基础环境 | ||
|
||
我们使用 rye 来管理多 python 包组成 monorepo,多个包会共享同一个虚拟环境 venv | ||
|
||
- 请先自行安装 `rye` `npm` | ||
|
||
```shell | ||
rye sync # 安装依赖 | ||
``` | ||
|
||
### lab | ||
|
||
```shell | ||
cd lab | ||
npm install # 依赖安装 | ||
npm run dev # 启动开发 | ||
npm run build # 构建 | ||
npm run deploy # 构建产物复制到 libro-server | ||
``` | ||
|
||
### libro-server | ||
|
||
```shell | ||
cd libro-server | ||
npm i # 安装非 python 依赖 | ||
rye run dev # 启动服务器 | ||
rye build # 打包 | ||
rye publish # 发布到 pypi | ||
``` | ||
|
||
### libro-ai | ||
|
||
```shell | ||
cd libro-ai | ||
rye build | ||
rye publish | ||
``` | ||
|
||
### libro-flow | ||
|
||
```shell | ||
cd libro-flow | ||
rye build | ||
rye publish | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,51 @@ | ||
# Libro | ||
# libro-server | ||
|
||
## 使用 | ||
libro-server 是 libro 的服务端,基于 jupyter-server 开发。 | ||
|
||
## 安装 | ||
|
||
```sh | ||
pip install libro libro-ai | ||
libro | ||
pip install libro | ||
``` | ||
|
||
## 开发 | ||
## 模块 | ||
|
||
本项目包含 lab 目录下的 libro-lab 前端工程和 libro-server、libro-ai 两个 python 包,分别在 libro-server 和 libro-ai 目录下。 | ||
### libro-server | ||
|
||
### 基础环境 | ||
web 服务,在 jupyter-server 的基础上提供更丰富的交互能力。 | ||
|
||
我们使用 rye 来管理多 python 包组成 monorepo,多个包会共享同一个虚拟环境 venv | ||
### libro-ai | ||
|
||
- install `rye` `npm` | ||
- rye sync | ||
为 libro 提供对大模型和智能体的连接能力,让 libro 可以 i 通过 magic function 直接使用大模型。 | ||
|
||
### libro-lab | ||
### libro-flow | ||
|
||
- cd lab | ||
- npm install | ||
- npm run build | ||
- npm run deploy | ||
提供 libro 执行器、参数化等能力,让 libro 可以在更多场景被消费。 | ||
|
||
### libro-server | ||
### lab | ||
|
||
- cd libro-server | ||
- npm i | ||
- rye run dev | ||
- rye build | ||
- rye publish | ||
前端工程,提供 libro 服务的默认 web 客户端。 | ||
|
||
### libro-ai | ||
## 更多 | ||
|
||
- cd libro-ai | ||
- rye build | ||
- rye publish | ||
### 提交 issue | ||
|
||
### libro-flow | ||
😊 我们建议您使用[github issue](https://github.com/difizen/libro-server/issues) 提交您的疑问, 我们通常会在 2 日内回复。 | ||
|
||
### 贡献代码 | ||
|
||
🤝 请查阅 [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
|
||
### 贡献者 | ||
|
||
💪 感谢所有的贡献者 | ||
|
||
<a href="https://github.com/difizen/mana/graphs/contributors"> | ||
<img src="https://contributors-img.web.app/image?repo=difizen/libro-server" alt="List of Contributors"/> | ||
</a> | ||
|
||
### 联系我们 | ||
|
||
🤗 加入我们的钉钉答疑群与我们联系。 | ||
|
||
- cd libro-flow | ||
- rye build | ||
- rye publish | ||
<img src="https://libro.difizen.net/ding-qrcode.png" width="30%"> |