Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 2.56 KB

README.rst

File metadata and controls

83 lines (54 loc) · 2.56 KB

AtomShields

Build Codacy Read the Docs Version

What is AtomShields?

Security testing framework for repositories and source code.

This system has different modules that detect different vulnerabilities or files that may expose a risk, and the results obtained can be obtained or sent thanks to the reporting modules.

For developers: There is also the possibility to develop your own vulnerability detection (called checkers) or reporting modules. This tool offers certain facilities for those who want to implement their own modules, publish them and integrate them into the official ElevenPaths tool.


Installation

pip install atomshields

Basic usage

import atomshields

atoms = atomshields.AtomShieldsScanner('./MyRepo/')
atoms.project = "MyRepoName"

issues = atoms.run() # Executes all checkers and all reports

Run tests

# If you are in AtomShields directory
pip install -r requirements-dev.txt
py.test tests/

Generate docs

# If you are in AtomShields directory
pip install -r requirements-dev.txt
cd docs
make html