A tool to facilitate managing whitesource data
Project description
scanctl
=======
> A tool to facilitate managing Whitesource data
![PyPi](https://img.shields.io/pypi/v/scanctl.svg)
![Travis](https://img.shields.io/travis/spotify/scanctl.svg)
### Requirements:
* Python 3.6
* Whitesource [Filesystem Agent][]
[Filesystem Agent]: https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/File+System+Agent
### Development:
```sh
$ git clone git@github.com:spotify/scanctl.git
$ cd scanctl
# optionally create a virtualenv before installing
$ pyenv virtualenv 3.6.5 venv
$ pyenv activate venv
(venv) $ pip install -r requirements.txt
(venv) $ pip install -e .
# list all organizations and repositories from a remote
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-orgs
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-repos
# run a scan against a particular repository
(venv) $ scanctl scan --token $WHITESOURCE_API_TOKEN spotify/scanctl
```
### Release:
Follow the standard pull request workflow; tests will be run before merging.
Either as part of the pull request or as a commit to master, run the following
commands to increment the release version:
```sh
(venv) $ pip install -r requirements-dev.txt
(venv) $ bumpversion minor
(venv) $ git push && git push --tags
```
The next travis build will push the new package to PyPi.
### Code of Conduct
This project adheres to the [Open Code of Conduct][code-of-conduct]. By
participating, you are expected to honor this code.
[code-of-conduct]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md
=======
> A tool to facilitate managing Whitesource data
![PyPi](https://img.shields.io/pypi/v/scanctl.svg)
![Travis](https://img.shields.io/travis/spotify/scanctl.svg)
### Requirements:
* Python 3.6
* Whitesource [Filesystem Agent][]
[Filesystem Agent]: https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/File+System+Agent
### Development:
```sh
$ git clone git@github.com:spotify/scanctl.git
$ cd scanctl
# optionally create a virtualenv before installing
$ pyenv virtualenv 3.6.5 venv
$ pyenv activate venv
(venv) $ pip install -r requirements.txt
(venv) $ pip install -e .
# list all organizations and repositories from a remote
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-orgs
(venv) $ scanctl github --token $GITHUB_API_TOKEN list-repos
# run a scan against a particular repository
(venv) $ scanctl scan --token $WHITESOURCE_API_TOKEN spotify/scanctl
```
### Release:
Follow the standard pull request workflow; tests will be run before merging.
Either as part of the pull request or as a commit to master, run the following
commands to increment the release version:
```sh
(venv) $ pip install -r requirements-dev.txt
(venv) $ bumpversion minor
(venv) $ git push && git push --tags
```
The next travis build will push the new package to PyPi.
### Code of Conduct
This project adheres to the [Open Code of Conduct][code-of-conduct]. By
participating, you are expected to honor this code.
[code-of-conduct]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
scanctl-0.5.0.tar.gz
(10.5 kB
view hashes)
Built Distribution
Close
Hashes for scanctl-0.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb2312e9851f64360115dd808949c53018484eb6067b8e6ee9e879bf4aef1a9d |
|
MD5 | a3ff3a6d6926e655128e4e1442e949e7 |
|
BLAKE2b-256 | 859bc3398313e85b647d27be7b0baed93505830c0b7c309f1050183d16909133 |