scanctl 0.5.0

scanctl
=======

> 一个用于管理Whitesource数据的工具


### 要求

* Python 3.6
* Whitesource [文件系统代理][]

[文件系统代理]: https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/File+System+Agent

### 开发

```sh
$ git clone git@github.com:spotify/scanctl.git
$ cd scanctl

# 可选：在安装前创建一个虚拟环境
$ pyenv virtualenv 3.6.5 venv
$ pyenv activate venv

(venv) $ pip install -r requirements.txt
(venv) $ pip install -e .

# 从远程列出所有组织和存储库
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-orgs
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-repos

# 对特定的存储库执行扫描
(venv) $ scanctl scan --token $WHITESOURCE_API_TOKEN spotify/scanctl
```

### 发布

遵循标准的拉取请求工作流程；合并前将运行测试。
要么作为拉取请求的一部分，要么作为对master的提交，运行以下命令以递增版本号：
命令

```sh
(venv) $ pip install -r requirements-dev.txt
(venv) $ bumpversion minor
(venv) $ git push && git push --tags
```

下一个travis构建将推送新的软件包到PyPi。

### 行为准则

本项目遵循[开放行为准则][code-of-conduct]。通过
参与项目，您应遵守此行为准则。

[行为准则]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md