Generate config

README.rst

@@ -11,8 +11,8 @@ AtomShields
 .. |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.com/ElevenPaths/AtomShields.svg?token=gsrNB2DciSs6qu19pJHD&branch=master
-   :target: https://travis-ci.com/ElevenPaths/AtomShields
+.. |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&utm_medium=referral&utm_content=ElevenPaths/AtomShields&utm_campaign=Badge_Grade

VERSION

@@ -1 +1 @@
-0.1
+1.0.0

docs/source/atomshields.checkers.rst

@@ -20,22 +20,6 @@ atomshields.checkers.dsstore module
     :undoc-members:
     :show-inheritance:
 
-atomshields.checkers.metashield module
---------------------------------------
-
-.. automodule:: atomshields.checkers.metashield
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-atomshields.checkers.passwords module
--------------------------------------
-
-.. automodule:: atomshields.checkers.passwords
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 atomshields.checkers.retirejs module
 ------------------------------------
 

docs/source/atomshields.models.rst

@@ -0,0 +1,22 @@
+atomshields.models package
+==========================
+
+Submodules
+----------
+
+atomshields.models.issue module
+-------------------------------
+
+.. automodule:: atomshields.models.issue
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atomshields.models
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/atomshields.rst

@@ -7,12 +7,20 @@ Subpackages
 .. toctree::
 
     atomshields.checkers
-    atomshields.helpers
+    atomshields.models
     atomshields.reports
 
 Submodules
 ----------
 
+atomshields.helpers module
+--------------------------
+
+.. automodule:: atomshields.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 atomshields.scanner module
 --------------------------
 

docs/source/checkers.rst

@@ -1,24 +1,39 @@
-
 Checkers
 ========
 
 
 DS_STORE
 --------
 DS_STORE is a Mac OS X file containing information about the system that created it.
-These files are rarely filtered in. gitignore, providing information about the system of the author of the repository.
+These files are rarely filtered in. gitignore, providing information about the system of the
+author of the repository.
+
+.. autosummary::
+  atomshields.checkers.dsstore.DSStoreChecker
+
 
+----------------------------------------------------------------------------------------------------
 
 
 RetireJS
 --------
-The goal of Retire.js is to help you detect use of version of JavaScript libraries with known vulnerabilities.
-This checker finds js files with vulnerabilities. Also, the checker finds and download JS files linked via URL.
+The goal of Retire.js is to help you detect use of version of JavaScript libraries with
+known vulnerabilities. This checker finds js files with vulnerabilities.
+Also, the checker finds and download JS files linked via URL.
 
+.. autosummary::
+  atomshields.checkers.retirejs.RetireJSChecker
 
 
+----------------------------------------------------------------------------------------------------
+
 
 Target-blank
 ------------
 
-This checker helps you to detect the *target blank* vulnerability in your code files. For more details about the vulnerability, please see `this link <https://dev.to/ben/the-targetblank-vulnerability-by-example>`_.
+This checker helps you to detect the *target blank* vulnerability in your code files.
+For more details about the vulnerability please see
+`this link <https://dev.to/ben/the-targetblank-vulnerability-by-example>`_.
+
+.. autosummary::
+  atomshields.checkers.targetblank.TargetBlankChecker

docs/source/conf.py

@@ -15,7 +15,9 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+import subprocess
+
+sys.path.insert(0, os.path.abspath('../../'))
 
 def read_file(filename):
     with open(filename) as f:
@@ -29,7 +31,7 @@ def read_file(filename):
 author = u'ElevenPaths - Telefonica Digital España'
 
 # The short X.Y version
-version = u'0.1'
+version = read_file('../../VERSION')
 # The full version, including alpha/beta/rc tags
 release = read_file('../../VERSION')
 
@@ -170,6 +172,5 @@ def read_file(filename):
 
 
 # -- Extension configuration -------------------------------------------------
-
 autosummary_generate = True
 autodoc_member_order = 'bysource'

docs/source/getting_started.rst

@@ -12,9 +12,9 @@ Getting started
 .. |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.com/ElevenPaths/AtomShields.svg?token=gsrNB2DciSs6qu19pJHD&branch=master
-   :target: https://travis-ci.com/ElevenPaths/AtomShields
-   :alt: Build
+.. |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&utm_medium=referral&utm_content=ElevenPaths/AtomShields&utm_campaign=Badge_Grade
    :alt: Codacy

docs/source/reports.rst

@@ -1,13 +1,23 @@
-
 Reports
 ========
 
 
 Echo
 ----
-This reports prints on screen a summary of all issues found. The fields printed are Name, Severity and File affected.
+This reports prints on screen a summary of all issues found. The fields printed are Name,
+Severity and File affected.
+
+.. autosummary::
+  atomshields.reports.echo.EchoReport
+
+
+----------------------------------------------------------------------------------------------------
 
 
 Http Request
 ------------
-Sends hte full information of issues via HTTP. The endpoint must be setted into the config file in the directory *.atomshields* into your home path.
+Sends hte full information of issues via HTTP. The endpoint must be setted into the config file in
+the directory *.atomshields* into your home path.
+
+.. autosummary::
+  atomshields.reports.http.HttpReport

setup.py

@@ -33,22 +33,23 @@ def read_file(filename):
 
 
 package_name = 'atomshields'
+version = read_file('VERSION').strip()
 
 setup(
   name = package_name,
-  version = read_file('VERSION').strip(),
+  version = version,
   install_requires=read_file('requirements.txt').splitlines(),
   packages = find_packages(),
   author = 'ElevenPaths',
-  description = "Framework de pruebas de seguridad en repositorios de código fuente. Dispone de un sistema flexible para la realización de pruebas de seguridad y comunicación de resultados.",
+  description = "Security testing framework for repositories and source code.",
   long_description=open('README.rst').read(),
   author_email = 'diego.fernandez@11paths.com, david.amrani@11paths.com',
   url = 'https://github.com/ElevenPaths/AtomShields',
   project_urls={
       "Documentation": "https://atomshields.readthedocs.io",
       "Source Code": "https://github.com/ElevenPaths/AtomShields",
   },
-  download_url = 'https://github.com/ElevenPaths/AtomShields/tarball/0.1',
+  download_url = 'https://github.com/ElevenPaths/AtomShields/tarball/' + version,
   keywords = 'security, source code, analysis',
   license='Apache 2.0',
   classifiers=[
@@ -70,6 +71,9 @@ def read_file(filename):
 # Setup AtomShields
 from atomshields.scanner import AtomShieldsScanner
 AtomShieldsScanner.setup()
+<<<<<<< HEAD
 AtomShieldsScanner.generateConfig(show = False)
 
 
+=======
+>>>>>>> ccc8614f93e9164f5c419ec1461dd665d71356de