badpacketsllc/prospector repository overview

⁠docker-prospector

Prospector docker container image

⁠Building

Build the container locally by running $ docker build -t prospector .

⁠Usage

To run prospector against code in the current directory using the image from Docker Hub:

$ docker run --rm -it -v ${PWD}:/data:ro,Z badpacketsllc/prospector

To run prospector against code in the current directory using the image built locally from source:

$ docker run --rm -it -v ${PWD}:/data:ro,Z prospector

⁠Running tests

In order to keep code quality high, all merges must pass tests and static analysis. Currently, the test suite is designed to run locally like so (assuming you have Python 3.6 or higher available).

$ pip3 install --user pipenv
$ pipenv install --dev
$ pipenv run yamllint .
$ pipenv run prospector
$ pipenv run pytest

Travis runs the test suite whenever you push a commit to make sure everything is sane, but running the test suite locally before you push saves a lot of time!

⁠Contributing

Contributions are encouraged! Learn how to contribute by reading CONTRIBUTING.md⁠. Please be nice and follow our Code of Conduct⁠.

⁠License

GPLv2

⁠Author Information

Mathew Woodyard⁠

Bad Packets LLC⁠