Supertokens Python 项目启动与配置教程

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

在克隆了 Supertokens Python 项目之后，您将看到以下目录结构：

supertokens-python
├── .github/                # GitHub 相关的文件和目录
├── examples/              # 项目示例
├── integration_tests/     # 集成测试代码
├── scripts/               # 脚本文件
├── supertokens/           # Supertokens Python SDK 源代码
│   ├── __init__.py
│   ├── ...
│   └── version.py
├── tests/                 # 单元测试代码
├── README.md              # 项目说明文件
├── requirements.txt       # 项目依赖
└── setup.py               # 项目安装和打包脚本

• .github/：存放与 GitHub 相关的配置文件，例如代码审查的配置。
• examples/：包含使用 Supertokens Python SDK 的示例代码，可以帮助您快速入门。
• integration_tests/：包含集成测试代码，确保 SDK 在各种环境中正常工作。
• scripts/：包含一些项目相关的脚本文件，例如构建、部署脚本等。
• supertokens/：这是 SDK 的核心目录，包含了所有源代码。
• tests/：包含单元测试代码，用于验证 SDK 的各个功能。
• README.md：项目说明文件，介绍了项目的使用方法和功能。
• requirements.txt：列出了项目依赖的 Python 库。
• setup.py：用于安装和打包项目的脚本。

2. 项目的启动文件介绍

Supertokens Python SDK 的启动通常是通过在你的应用中导入 supertokens 模块并初始化来完成的。以下是一个简单的启动文件示例，通常位于你的应用的主目录中：

# app.py

from supertokens import init

# 初始化 Supertokens
init(
    connectionURI="http://localhost:8080",
    apiKey="YOUR_API_KEY",
    appInfo={
        "appName": "YourApp",
        "apiDomain": "yourapp.com",
        "websiteDomain": "www.yourapp.com"
    }
)

# 你的应用的其他逻辑

在这个启动文件中，我们使用 init 函数初始化了 Supertokens，需要提供连接到 Supertokens 服务端的 URI、API 密钥以及应用信息。

3. 项目的配置文件介绍

Supertokens Python SDK 的配置通常在启动文件中进行。除了启动文件中提到的初始化参数，您可能还需要配置其他选项，例如数据库连接信息、日志级别等。这些配置可以在环境变量中设置，或者在 supertokens 初始化时传入一个配置字典。

以下是一个配置文件的示例：

# config.py

import os

# 从环境变量获取配置
CONNECTION_URI = os.getenv('SUPERTOKENS_CONNECTION_URI', 'http://localhost:8080')
API_KEY = os.getenv('SUPERTOKENS_API_KEY', 'YOUR_API_KEY')
APP_NAME = os.getenv('SUPERTOKENS_APP_NAME', 'YourApp')
API_DOMAIN = os.getenv('SUPERTOKENS_API_DOMAIN', 'yourapp.com')
WEBSITE_DOMAIN = os.getenv('SUPERTOKENS_WEBSITE_DOMAIN', 'www.yourapp.com')

# 配置字典
supertokens_config = {
    'connectionURI': CONNECTION_URI,
    'apiKey': API_KEY,
    'appInfo': {
        'appName': APP_NAME,
        'apiDomain': API_DOMAIN,
        'websiteDomain': WEBSITE_DOMAIN
    }
    # 其他可能的配置
}

# 你的应用可以导入这个配置字典并在启动时使用

然后，在你的应用启动文件中，你可以导入这个配置字典并使用它来初始化 Supertokens：

# app.py

from supertokens import init
from config import supertokens_config

# 使用配置字典初始化 Supertokens
init(**supertokens_config)

# 你的应用的其他逻辑

通过这样的配置管理，您可以方便地根据部署环境的不同，调整配置而无需修改代码。