Metadata-Version: 1.1
Name: w3af-api-client
Version: 1.1.7
Summary: REST API client to consume w3af
Home-page: https://github.com/andresriancho/w3af-api-client/
Author: Andres Riancho
Author-email: andres.riancho@gmail.com
License: GNU General Public License v2 (GPLv2)
Description: REST API client for w3af
        ========================
        
        Launch web application security scans using `w3af's REST API <http://docs.w3af.org/en/latest/api/index.html>`_
        
        .. image:: https://circleci.com/gh/andresriancho/w3af-api-client.svg?style=svg
           :alt: Build Status
           :align: right
           :target: https://circleci.com/gh/andresriancho/w3af-api-client
        
        Installation
        ============
        
        ::
        
            $ pip install --upgrade w3af-api-client
        
        
        Usage
        =====
        
        The REST API client allows you to run scans and access results and log files.
        
        ::
        
            from w3af_api_client import Connection, Scan
        
            # Connect to the REST API and get it's version
            conn = Connection('http://127.0.0.1:5000/')
            print conn.get_version()
        
            # Define the target and configuration
            scan_profile = file('/path/to/profile.pw3af').read()
            target_urls = ['http://example.target']
        
            scan = Scan(conn)
            scan.start(scan_profile, target_urls)
        
            # Wait some time for the scan to start and then
            scan.get_urls()
            scan.get_log()
            scan.get_findings()
        
        
        Source code
        ===========
        
        Developers love code, here's all you need to understand, use and extend the client:
        
        * `w3af's REST API server <https://github.com/andresriancho/w3af/tree/master/w3af/core/ui/api/>`_
        * `w3af's REST API client <https://github.com/andresriancho/w3af-api-client/>`_
        
        Reporting bugs
        ==============
        
        Report your issues and feature requests in `w3af-api-client's issue
        tracker <https://github.com/andresriancho/w3af-api-client>`_ and we'll
        be more than glad to fix them.
        
        Pull requests are more than welcome!
        
        
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: System :: Monitoring
