Metadata-Version: 1.1
Name: atomshields
Version: 1.0.0
Summary: Security testing framework for repositories and source code.
Home-page: https://github.com/ElevenPaths/AtomShields
Author: ElevenPaths
Author-email: diego.fernandez@11paths.com, david.amrani@11paths.com
License: Apache 2.0
Download-URL: https://github.com/ElevenPaths/AtomShields/tarball/1.0.0
Project-URL: Source Code, https://github.com/ElevenPaths/AtomShields
Project-URL: Documentation, https://atomshields.readthedocs.io
Description: 
        AtomShields
        ===============
        
        
        |Build| |Codacy| |Docs| |Version|
        
        .. |Docs| image:: https://readthedocs.org/projects/atomshields/badge/?version=latest
           :target: http://atomshields.readthedocs.io/en/latest/?badge=latest
           :alt: Read the Docs
        .. |Version| image:: http://img.shields.io/pypi/v/atomshields.svg?style=flat
           :target: https://pypi.python.org/pypi/atomshields/
           :alt: Version
        .. |Build| image:: https://travis-ci.org/ElevenPaths/AtomShields.svg?branch=master
           :target: https://travis-ci.org/ElevenPaths/AtomShields
           :alt: Build
        .. |Codacy| image:: https://api.codacy.com/project/badge/Grade/46c76e50709e4079828d5fecafa60473
           :target: https://www.codacy.com?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=ElevenPaths/AtomShields&amp;utm_campaign=Badge_Grade
           :alt: Codacy
        .. |Coverage| image:: https://api.codacy.com/project/badge/Coverage/46c76e50709e4079828d5fecafa60473
           :target: https://www.codacy.com?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=ElevenPaths/AtomShields&amp;utm_campaign=Badge_Coverage
           :alt: Coverage
        
        
        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
        ------------
        
        .. code-block:: shell
        
          pip install atomshields
        
        
        ------------------------------------------------------------------------------------------
        
        Basic usage
        -----------
        
        .. code-block:: python
        
          import atomshields
        
          atoms = atomshields.AtomShieldsScanner('./MyRepo/')
          atoms.project = "MyRepoName"
        
          issues = atoms.run() # Executes all checkers and all reports
        
        ------------------------------------------------------------------------------------------
        
        Run tests
        ---------
        
        .. code-block:: python
        
          # If you are in AtomShields directory
          pip install -r requirements-dev.txt
          py.test tests/
        
        ------------------------------------------------------------------------------------------
        
        Generate docs
        -------------
        
        .. code-block:: shell
        
          # If you are in AtomShields directory
          pip install -r requirements-dev.txt
          cd docs
          make html
        
Keywords: security,source code,analysis
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
