CloudConvert Python SDK 使用教程

1. 项目目录结构及介绍

CloudConvert Python SDK 的目录结构如下：

cloudconvert-python/
├── .github/
│   ├── workflows/
│   └── ...
├── .vscode/
│   └── ...
├── cloudconvert/
│   ├── __init__.py
│   ├── api.py
│   ├── tasks.py
│   ├── ...
├── tests/
│   ├── __init__.py
│   ├── test_api.py
│   ├── test_tasks.py
│   ├── ...
├── .gitignore
├── LICENCE
├── README.md
├── requirements.txt
├── setup.py

• .github/ 目录包含了项目的 GitHub Actions 工作流配置文件。
• .vscode/ 目录包含了 Visual Studio Code 的项目配置文件。
• cloudconvert/ 目录是 SDK 的核心代码目录，包含了 SDK 的初始化文件、API 接口定义、任务处理等。
• tests/ 目录包含了 SDK 的单元测试和集成测试代码。
• .gitignore 文件指定了 Git 忽略的文件和目录。
• LICENCE 文件包含了项目的开源协议。
• README.md 文件是项目的自述文件，包含了项目的基本信息和如何使用。
• requirements.txt 文件指定了项目运行所需的 Python 包依赖。
• setup.py 文件是 Python 包的配置文件，用于包的安装和分发。

2. 项目的启动文件介绍

项目的启动主要通过 cloudconvert/__init__.py 文件来实现。该文件定义了 SDK 的初始化方法，用于配置 API 密钥和沙盒模式等。

from .api import Api

def configure(api_key, sandbox=False):
    Api.api_key = api_key
    Api.sandbox = sandbox

def default():
    return Api()

用户需要在使用 SDK 之前调用 configure 方法来设置 API 密钥和沙盒模式。如果需要使用默认配置，可以直接调用 default 方法。

3. 项目的配置文件介绍

项目的配置主要通过 setup.py 文件来进行。该文件定义了项目的元数据和安装依赖。

from setuptools import setup, find_packages

setup(
    name='cloudconvert-python',
    version='2.1.0',
    packages=find_packages(),
    install_requires=[
        'requests>=2.20.0',
        # 其他依赖
    ],
    # 其他配置
)

在这个文件中，指定了项目的名称、版本、包含的包、依赖的 Python 包等。用户在安装 SDK 时，可以通过 pip install cloudconvert-python 命令来自动安装这些依赖项。