Skip to content

Commit 3f8cf6d

Browse files
woodradwoodrad
committed
Initial commit
0 parents  commit 3f8cf6d

File tree

12 files changed

+832
-0
lines changed

12 files changed

+832
-0
lines changed

‎.gitignore

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# IDE artifacts
132+
.idea/
133+
134+
# Pipenv
135+
Pipfile.lock

‎.travis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
language: python
3+
python:
4+
- "3.8"
5+
services: docker
6+
cache: pip
7+
install:
8+
- pip3 install yamllint testinfra prospector
9+
script:
10+
- yamllint .
11+
- prospector
12+
- pytest

‎AUTHORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Bad Packets, LLC
2+
Mathew Woodyard

‎CODE_OF_CONDUCT.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq
77+

‎CONTRIBUTING.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
Contributing
2+
============
3+
4+
Contributions are welcome and appreciated! All contributors will be credited in
5+
`AUTHORS`.
6+
7+
Types of Contributions
8+
----------------------
9+
10+
You can contribute in several different ways:
11+
12+
### Report bugs
13+
14+
Report bugs at https://github.com/badpacketsllc/prospector/issues.
15+
16+
If you are reporting a bug, please include:
17+
18+
- Expected behavior and observed behavior.
19+
- How to reproduce the bug.
20+
- Any information you think would be helpful in finding the bug's root cause.
21+
22+
### Fix Bugs
23+
24+
Look through the GitHub issues for bugs. Feel free to contribute any fixes you
25+
might have.
26+
27+
### Implement Features
28+
29+
Look through the GitHub issues for features. Feel free to contribute any
30+
features you wish to implement.
31+
32+
### Write Documentation
33+
34+
More clarity is always better. Add documentation to `README.md`, in the test
35+
suite or wherever you feel is appropriate.
36+
37+
Setting up a development environment
38+
------------------------------------
39+
40+
1. Fork the `prospector` repo on GitHub.
41+
2. Clone your fork locally:
42+
43+
```shell
44+
$ git clone [email protected]:your_name_here/prospector.git
45+
```
46+
47+
3. [Install docker](https://docs.docker.com/get-started/).
48+
49+
4. Create a branch for local development
50+
```shell
51+
$ git checkout -b description-of-bug-or-feature
52+
````
53+
54+
Now you can make your changes locally.
55+
56+
5. When you're done making changes, check that your changes pass the tests:
57+
58+
```shell
59+
$ pip3 install tox
60+
$ tox
61+
```
62+
63+
6. Commit your changes and push your branch to GitHub:
64+
65+
```shell
66+
$ git add .
67+
$ git commit -m "Your detailed description of your changes."
68+
$ git push origin name-of-your-bugfix-or-feature
69+
```
70+
71+
7. Submit a pull request through the GitHub website.
72+
73+
Responsibilities
74+
----------------
75+
76+
1. Create issues for any bugs, changes or enhancements.
77+
2. Be welcoming and nice as outlined in our Code of Conduct (https://www.contributor-covenant.org/version/1/4/code-of-conduct).

‎Dockerfile

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Run prospector static analysis using docker.
2+
#
3+
# To build:
4+
# $ docker build -t prospector .
5+
#
6+
# To run:
7+
# To display the command line options:
8+
# $ docker run --rm -it prospector --help
9+
# .. will display the command line help
10+
#
11+
# To run `prospector` against code in the current directory using the image
12+
# from Docker Hub:
13+
# $ docker run --rm -it -v $PWD:/data:ro,Z badpacketsllc/prospector prospector
14+
#
15+
# To run `prospector` against code in the current directory using the image
16+
# built locally from source
17+
# $ docker run --rm -it -v $PWD:/data:ro,Z prospector
18+
#
19+
# Copyright 2020 Bad Packets LLC
20+
# Licensed under a GPLv2 license
21+
22+
FROM python:3.8-alpine
23+
24+
RUN pip3 install prospector
25+
26+
WORKDIR /data
27+
28+
ENTRYPOINT ["prospector"]
29+
CMD []

0 commit comments

Comments
 (0)