laminhub-rest: 跨实例管理

注意：有关更详细的文档和测试，请参阅docs。

摘要

1. 安装
2. CLI
   1. 运行服务器
   2. 运行测试
   3. 启动Jupyter lab
   4. 迁移
3. 部署
4. 用法
5. 发布流程

1. 安装

1. 克隆此存储库

2. 导航到存储库并运行

   pip install .
   

2. 依赖项

1. Supabase CLI

   要在本地环境中使用lnhub CLI，您首先必须安装和配置Supabase CLI。

2. Docker

   您还必须安装Docker，以便允许Supabase CLI创建和运行相关容器

3. 本地开发

lnhub 脚本用作您需要运行的所有本地开发操作的入口点。

:warning: 使用此入口点非常重要，因为它正确地配置了设置。

为确保环境配置正确，您可以选择以下三种方法之一

1. 在运行 lnhub 之前设置 LAMIN_ENV=local。这将确保启动本地Supabase实例并正确配置连接字符串。

2. 如果您想连接到外部Supabase（无论是在云中还是由其他进程管理），您可以自定义 LAMIN_ENV=foobar（或 prod 或 staging）并在根目录中放置相应的 .env 文件。在这种情况下将是 laminhub-rest--foobar.env。

   • .env 文件必须包含以下变量的值

     POSTGRES_DSN
     SUPABASE_API_URL
     SUPABASE_ANON_KEY
     SUPABASE_SERVICE_KEY
     

运行服务器

LAMIN_ENV=local lnhub run

运行测试

LAMIN_ENV=local lnhub test -s test_local

在 lnhub test 命令之后的任何参数都直接传递给 nox

启动Jupyter lab

LAMIN_ENV=local lnhub jupyter

打开IPython shell

LAMIN_ENV=local lnhub shell

迁移

参见迁移

3. 部署

在 staging 分支上推送以部署到预发布环境。

在 main 分支上推送以部署到生产环境。

4. 用法

从这些端点访问API文档。

本地

https://:8000/docs

在 staging 服务器上

https://laminhub-rest-cloud-run-staging-xv4y7p4gqa-uc.a.run.app/docs

在生产服务器上

https://laminhub-rest-cloud-run-main-xv4y7p4gqa-uc.a.run.app/docs

5. 发布流程