neon_client：Neon API的API包装器。

neon_client是一个Python包装器，旨在简化与Neon API的交互。它为开发者提供了一个方便的方式来将他们的Python应用程序与Neon平台集成，提供管理API密钥、项目、分支、数据库、端点、角色和操作的方法。

使用neon_client，您可以自动化任务，简化工作流程，轻松构建强大的集成。

安装

$ pip install neon-client

请注意：此存储库是正在进行中的工作。该软件包尚未在PyPi上提供。上面的命令将不起作用。

使用方法

from neon_client import NeonAPI

# Initialize the client.
neon = NeonAPI(api_key='your_api_key')

请记住，您永远不应该公开您的api_key，并且要小心处理它，因为它可以访问敏感数据。最好将其设置为环境变量（例如NEON_API_KEY + 相关的neon_client.from_environ()）。

NeonAPI类的函数

• me()：返回当前用户。

管理API密钥:

• api_keys()：返回API密钥列表。
• api_key_create(**json)：创建API密钥。
• api_key_delete(key_id)：删除指定的API密钥。

管理项目:

• projects()：返回项目列表。
• project(project_id)：返回特定的项目。
• project_create(project_id, **json)：创建新项目。
• project_update(project_id, **json)：更新指定的项目。
• project_delete(project_id)：删除指定的项目。
• project_permissions(project_id)：返回指定项目的权限列表。
• project_permissions_grant(project_id, **json)：授予指定项目的权限。
• project_permissions_revoke(project_id, **json)：从指定项目中撤销权限。

管理分支:

• branches(project_id)：返回指定项目的分支列表。
• branch(project_id, branch_id)：返回特定的分支。
• branch_create(project_id, **json)：创建新的分支。
• branch_update(project_id, branch_id, **json)：更新指定的分支。
• branch_delete(project_id, branch_id)：删除指定的分支。
• branch_set_as_primary(project_id, branch_id)：将指定的分支设置为默认。

管理数据库:

• databases(project_id, branch_id)：返回指定项目和分支的数据库列表。
• database(project_id, branch_id, database_id)：返回特定的数据库。
• database_create(project_id, branch_id, **json)：创建新的数据库。
• database_update(project_id, branch_id, **json)：更新指定的数据库。
• database_delete(project_id, branch_id, database_id)：删除指定的数据库。

管理端点:

• endpoints(project_id, branch_id)：返回指定项目和分支的端点列表。
• endpoint_create(project_id, branch_id, **json)：创建新的端点。
• endpoint_update(project_id, branch_id, endpoint_id, **json)：更新指定的端点。
• endpoint_delete(project_id, branch_id, endpoint_id)：删除指定的端点。
• endpoint_start(project_id, branch_id, endpoint_id)：启动指定的端点。
• endpoint_suspend(project_id, branch_id, endpoint_id)：挂起指定的端点。

管理角色:

• roles(project_id, branch_id)：返回指定项目和分支的角色列表。
• role(project_id, branch_id, role_name)：返回特定的角色。
• role_create(project_id, branch_id, role_name)：创建新的角色。
• role_delete(project_id, branch_id, role_name)：删除指定的角色。
• role_password_reveal(project_id, branch_id, role_name)：显示指定角色的密码。
• role_password_reset(project_id, branch_id, role_name)：重置指定角色的密码。

管理操作:

• operations(project_id)：返回指定项目的操作列表。
• operation(project_id, operation_id)：返回特定的操作。

实验性:

• consumption()：返回项目消耗指标列表。

查看Neon API文档获取有关可用端点和其参数的更多信息。

开发

使用pipenv安装简单。只需在存储库根目录中运行以下命令

$ pipenv install --dev

这将安装所有必要的开发依赖项。

要运行测试，请使用以下命令

$ make test

由于使用pytest-vcr库进行模拟，测试不需要互联网连接。要记录新磁带，请使用以下命令

$ make record

这将为新测试记录新的磁带。确保在您的更改中提交这些磁带。

许可证和版权

MIT许可.