CodeBox API 使用教程

CodeBox API 使用教程

codebox-api📦 CodeBox is the simplest cloud infrastructure for your LLM Apps and Services.项目地址:https://gitcode.com/gh_mirrors/co/codebox-api

1. 项目的目录结构及介绍

CodeBox API 是一个用于运行 Python 代码的简单云基础设施。以下是项目的目录结构及其介绍：

codebox-api/
├── codeboxapi/
│   ├── __init__.py
│   ├── core.py
│   ├── utils.py
│   └── ...
├── tests/
│   ├── test_core.py
│   ├── test_utils.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

• codeboxapi/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件。
  • core.py: 核心功能实现。
  • utils.py: 工具函数。
• tests/: 包含项目的测试文件。
  • test_core.py: 核心功能的测试。
  • test_utils.py: 工具函数的测试。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 codeboxapi/core.py。该文件包含了 CodeBox 的主要功能实现，包括启动、运行代码等。

# codeboxapi/core.py

import os
import requests

class CodeBox:
    def __init__(self):
        self.api_key = os.getenv("CODEBOX_API_KEY")
        self.base_url = "https://api.codeboxapi.com"

    def start(self):
        # 启动 CodeBox
        response = requests.post(f"{self.base_url}/start", headers={"Authorization": f"Bearer {self.api_key}"})
        return response.json()

    def run(self, code):
        # 运行代码
        response = requests.post(f"{self.base_url}/run", headers={"Authorization": f"Bearer {self.api_key}"}, json={"code": code})
        return response.json()

    def status(self):
        # 获取状态
        response = requests.get(f"{self.base_url}/status", headers={"Authorization": f"Bearer {self.api_key}"})
        return response.json()

3. 项目的配置文件介绍

项目的配置文件是 .env 文件。该文件用于存储 API 密钥等敏感信息。

# .env

CODEBOX_API_KEY=your-api-key

在代码中，可以通过 os.getenv("CODEBOX_API_KEY") 来获取该配置项的值。

# codeboxapi/core.py

import os

class CodeBox:
    def __init__(self):
        self.api_key = os.getenv("CODEBOX_API_KEY")
        self.base_url = "https://api.codeboxapi.com"

通过以上配置，可以确保 API 密钥的安全性，避免在代码中硬编码敏感信息。

codebox-api📦 CodeBox is the simplest cloud infrastructure for your LLM Apps and Services.项目地址:https://gitcode.com/gh_mirrors/co/codebox-api