Orchester允许您轻松地添加/删除对您喜爱的平台的使用。
orchester的Python项目详细描述
管弦乐队
这是一组python工具,用于轻松管理用户对首选云服务的成员资格。
开始
使用pip install orchester
如果要使用命令行界面,必须定义一些配置。
配置是通过.orchester.json
配置文件完成的。你可以在这里看到一个模板:.orchester.json
配置文件必须是:
- path在orchester_config_path环境变量中定义。
- 在当前工作目录中
- 在用户文件夹中(主页)
cli
管弦乐队是用命令行工具分发的。安装后,您可以使用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
标识符:使用trello用户名
- 从https://trello.com/app-key
- 运行
/bin/trello_token.py
脚本以获取凭据 - 在.env文件中设置OAuth令牌和OAuth机密
Github
连接器:github
标识符:使用github用户名
要使用github服务,您需要一个个人令牌。
在Settings > Developer settings > Personal access tokens
下转到github
然后,创建一个新令牌并将其保存在.env
文件中。
松弛度
连接器:松弛
identifier:使用松弛电子邮件
要开始使用slack,首先需要获得一个遗留令牌和一个oauth令牌。
legacy令牌
只需转到以下URL并发出新的旧令牌:https://api.slack.com/custom-integrations/legacy-tokens
Note: You'll need to be connected to issue a token.
oauth令牌
由于slack使用oauth令牌,我们必须执行一些操作。
- 启动
bin/slack_token.py
服务器。 - 转到:
http://localhost:8888/begin_auth
- 单击“添加到松弛状态”
警告
因为我们只使用免费版本,所以不能使用api删除用户。
谷歌硬盘
标识符:使用谷歌电子邮件
连接器:G U驱动器
在开始之前,您需要在这个文件夹的根目录下有一个google_drive_credentials.json
文件。
您可以通过在google控制台api中创建凭据来获得它
tutorial:教程来自:https://developers.google.com/drive/api/v3/quickstart/python
创建凭证文件后,可以运行bin/gdrive_token.py
来创建google_drive_token.json
API
api是非常直接的。每个连接器都继承自orchester.connectors.AbstractBaseConnector
如果要同时使用所有连接器,可以使用orchester.ConnectorManager
管理器实例化所有连接器,让您可以轻松地一次与一个连接器交互。
下面是使用github连接器的示例:
fromorchester.connectorsimportGithubConnector,RequestFailedErrorconnector=GithubConnector(access_token="my token...",organization_id='myOrg')try:user_exist=connector.is_registered_to_group('popojargo')print('User is registered to myOrg')exceptRequestFailedError:print('The request failed.')try:connector.remove_from_group('popojargo')print('User removed to myOrg')exceptRequestFailedError:print('The request failed.')try:user_exist=connector.add_to_group('popojargo')print('User added to myOrg')exceptRequestFailedError:print('The request failed.')
贡献
有关开发人员文档,请参见README-DEV.md