orchester

这是一个Python工具集，可轻松管理您首选云服务的用户成员资格。

• orchester
  • 入门
  • 命令行界面
  • 连接器
    • Trello
    • Github
    • Slack
    • Google Drive
  • API
  • 贡献

入门

使用pip install orchester安装包

如果您想使用命令行界面，您必须定义一些配置。

配置

配置通过.orchester.json配置文件完成。您可以在以下位置查看文档模板：.orchester-doc.json 标记为[CLI]的值仅适用于命令行界面。

注意：空模板在此处可用：.orchester.json

应用程序将按以下顺序尝试加载：

• 在环境变量ORCHESTER_CONFIG_PATH中定义的特定路径。
• 当前工作目录
• 用户文件夹（主目录）

命令行界面

Orchester附带命令行工具。安装后，您可以使用orchest --help调用它

以下命令可用：

• orchest -c CONNECTOR_TYPE check IDENTIFIER：检查用户是否已注册到组织
• orchest -c CONNECTOR_TYPE add IDENTIFIER 将用户添加到组织
• orchest -c CONNECTOR_TYPE rm IDENTIFIER：从组织中删除用户
• orchest generate CONNECTOR_TYPE：为连接器生成OAuth凭证

如果要在每个命令中省略CONNECTOR_TYPE，您可以在配置文件中设置默认连接器

"default_connector": "trello"

连接器类型必须是有效连接器的CONNECTOR名称。连接器在下一节中描述。

连接器

Trello

CONNECTOR：trello

IDENTIFIER：使用trello用户名

1. 从https://trello.com/app-key（查找Api Key和OAuth secret）获取API令牌和秘密
2. 在.orchester.json配置文件中将Api Key和OAuth secret添加到api_key和api_secret。
3. 运行orchest generate trello脚本来获取凭证
4. 在配置文件中将OAuth令牌和OAuth秘密设置为token和token_secret

Github

CONNECTOR：github

IDENTIFIER：使用github用户名

要使用Github服务，您需要一个个人令牌。

在Github上转到Settings > Developer settings > Personal access tokens

然后，创建一个新的令牌并将其保存在配置文件的token中。

Slack

CONNECTOR：slack

IDENTIFIER：使用slack电子邮件

要开始使用slack，您首先需要获取一个旧版令牌和一个OAuth令牌。

旧版令牌

只需访问以下url并发出一个新的旧版令牌：https://api.slack.com/custom-integrations/legacy-tokens

您可以在legacy_token中添加旧版令牌。

注意：您需要连接才能发出令牌。

OAuth令牌

在您实际上可以生成OAuth令牌之前，您需要有一个Slack应用程序。

如何创建应用？：转到https://api.slack.com/apps并单击创建新应用
您必须添加以下权限范围：users:read和users:read.email
您还需要设置以下重定向URI：http://localhost:8888/finish_auth

然后，您可以将客户端ID和客户端秘密存储在client_id和client_secret中

您现在已设置完毕，可以生成最终的OAuth令牌。

1. 运行orchest generate slack
2. 转到：http://localhost:8888/begin_auth
3. 单击“添加到slack”
4. 单击授权
5. 应该会显示一个OAuth令牌。将其保存在配置文件的token中

警告：免费Slack用户无法使用API删除用户。

Google Drive

IDENTIFIER：使用google电子邮件

CONNECTOR：g_drive

在您开始之前，您需要在该文件夹根目录下有一个google_drive_credentials.json文件。

您可以通过在Google Console API中创建凭据来获取它

教程：教程来源：https://developers.google.com/drive/api/v3/quickstart/python

一旦您有了credentials.json文件，您需要定义credential_path和token_path。

之后，您就可以运行orchest generate g_drive来创建google_drive_token.json。

API

API相当简单。每个连接器都继承自orchester.connectors.AbstractBaseConnector

如果您想同时使用所有连接器，您可以使用orchester.ConnectorManager

管理器实例化所有连接器，并允许您轻松地逐个与连接器交互。

以下是如何使用github连接器的示例

from orchester.connectors import GithubConnector, RequestFailedError

connector = GithubConnector(access_token="my token...",organization_id='myOrg')

try:
    user_exist = connector.is_registered_to_group('popojargo')
    print('User is registered to myOrg')
except RequestFailedError:
    print('The request failed.')


try:
    connector.remove_from_group('popojargo')
    print('User removed to myOrg')

except RequestFailedError:
    print('The request failed.')


try:
    user_exist = connector.add_to_group('popojargo')
    print('User added to myOrg')

except RequestFailedError:
    print('The request failed.')

贡献

有关开发人员文档，请参阅README-DEV.md