Metadata-Version: 2.1
Name: threadfixproapi
Version: 1.0.4
Summary: Python library enumerating the ThreadFix Professional RESTFul API.
Home-page: https://github.com/target/threadfixproapi
Author: Brandon Spruth
Author-email: brandon.spruth2@target.com
License: MIT
Download-URL: https://github.com/target/threadfixproapi/tarball/1.0.4
Keywords: threadfix,api,security,software,denim group,sast,dast
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: requests

.. image:: https://img.shields.io/pypi/v/threadfixproapi.svg
   :target: https://pypi.org/project/threadfixproapi
.. image:: https://img.shields.io/pypi/pyversions/threadfixproapi.svg
.. image:: https://img.shields.io/travis/target/threadfixproapi/master.svg
   :target: http://travis-ci.org/target/threadfixproapi

ThreadFix Pro API
*****************

A Python module to assist with the `ThreadFix Professional <https://www.threadfix.it/>`__ RESTFul API to administer scan artifacts and overall ThreadFix vulnerability administration.

Quick Start
~~~~~~~~~~~

Several quick start options are available:

- Install with pip: ``pip install threadfixproapi``
- Build locally: ``python setup.py install``
- `Download the latest release <https://git.target.com/tts-pse/threadfixproapi/releases/new/>`__.

Example
~~~~~~~

::

    # import the package
    from threadfixproapi import threadfixpro

    # setup threadfix connection information
    host = 'https://127.0.0.1:8443/threadfix/'
    api_key = 'your_api_key_from_threadfix_professional'

    # initialize threadfix pro api module
    tfp = threadfixpro.ThreadFixProAPI(host, api_key)

    # If you need to disable certificate verification.
    # tfp = threadfixpro.ThreadFixProAPI(host, api_key, verify_ssl=False)

    # List your threadfix pro teams
    teams = tfp.list_teams()
    if teams.success:
        print("{}".format(teams.data))

        for team in teams.data:
            print(team['name'])  # Print the name of each team
    else:
        print("ERROR: {}".format(teams.message))

Supporting information for each method available can be found in the `documentation <https://target.github.io/threadfixapi/>`__.

Bugs and Feature Requests
~~~~~~~~~~~~~~~~~~~~~~~~~

Found something that doesn't seem right or have a feature request? `Please open a new issue <https://git.target.com/tts-pse/threadfixproapi/issues/new>`__.

Copyright and License
~~~~~~~~~~~~~~~~~~~~~
.. image:: https://img.shields.io/github/license/target/threadfixproapi.svg?style=flat-square

- Copyright 2018 Target Brands, Inc.


