Initial commit

.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDE artifacts
+.idea/
+
+# Pipenv
+Pipfile.lock

.travis.yml

@@ -0,0 +1,12 @@
+---
+language: python
+python:
+  - "3.8"
+services: docker
+cache: pip
+install:
+  - pip3 install yamllint testinfra prospector
+script:
+  - yamllint .
+  - prospector
+  - pytest

AUTHORS

@@ -0,0 +1,2 @@
+Bad Packets, LLC
+Mathew Woodyard

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+Contributing
+============
+
+Contributions are welcome and appreciated! All contributors will be credited in
+`AUTHORS`.
+
+Types of Contributions
+----------------------
+
+You can contribute in several different ways:
+
+### Report bugs
+
+Report bugs at https://github.com/badpacketsllc/prospector/issues.
+
+If you are reporting a bug, please include:
+
+- Expected behavior and observed behavior.
+- How to reproduce the bug.
+- Any information you think would be helpful in finding the bug's root cause.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Feel free to contribute any fixes you
+might have.
+
+### Implement Features
+
+Look through the GitHub issues for features. Feel free to contribute any
+features you wish to implement.
+
+### Write Documentation
+
+More clarity is always better. Add documentation to `README.md`, in the test
+suite or wherever you feel is appropriate.
+
+Setting up a development environment
+------------------------------------
+
+1. Fork the `prospector` repo on GitHub.
+2. Clone your fork locally:
+
+```shell
+    $ git clone [email protected]:your_name_here/prospector.git
+```
+
+3. [Install docker](https://docs.docker.com/get-started/).
+
+4. Create a branch for local development
+```shell
+    $ git checkout -b description-of-bug-or-feature
+````
+
+Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass the tests:
+
+```shell
+    $ pip3 install tox
+    $ tox
+```
+
+6. Commit your changes and push your branch to GitHub:
+
+```shell
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+```
+
+7. Submit a pull request through the GitHub website.
+
+Responsibilities
+----------------
+
+1. Create issues for any bugs, changes or enhancements.
+2. Be welcoming and nice as outlined in our Code of Conduct (https://www.contributor-covenant.org/version/1/4/code-of-conduct).

Dockerfile

@@ -0,0 +1,29 @@
+# Run prospector static analysis using docker.
+#
+# To build:
+# $ docker build -t prospector .
+#
+# To run:
+# To display the command line options:
+# $ docker run --rm -it prospector --help
+# .. will display the command line help
+#
+# 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 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
+#
+# Copyright 2020 Bad Packets LLC
+# Licensed under a GPLv2 license
+
+FROM python:3.8-alpine
+
+RUN pip3 install prospector
+
+WORKDIR /data
+
+ENTRYPOINT ["prospector"]
+CMD []