|
| 1 | +.. image:: https://img.shields.io/pypi/v/threadfixproapi.svg |
| 2 | + :target: https://pypi.org/project/threadfixproapi |
| 3 | +.. image:: https://img.shields.io/pypi/pyversions/threadfixproapi.svg |
| 4 | +.. image:: https://img.shields.io/travis/target/threadfixproapi/master.svg |
| 5 | + :target: http://travis-ci.org/target/threadfixproapi |
| 6 | + |
| 7 | +ThreadFix Pro API |
| 8 | +***************** |
| 9 | + |
| 10 | +A Python module to assist with the `ThreadFix <https://www.threadfix.it/>`__ RESTFul API to administer scan artifacts and overall ThreadFix vulnerability administration. |
| 11 | + |
| 12 | +Quick Start |
| 13 | +~~~~~~~~~~~ |
| 14 | + |
| 15 | +Several quick start options are available: |
| 16 | + |
| 17 | +- Install with pip: ``pip install threadfixproapi`` |
| 18 | +- Build locally: ``python setup.py install`` |
| 19 | +- `Download the latest release <https://github.com/denimgroup/threadfix-python-api/releases/new/>`__. |
| 20 | + |
| 21 | +Example |
| 22 | +~~~~~~~ |
| 23 | + |
| 24 | +:: |
| 25 | + |
| 26 | + # import the package |
| 27 | + from threadfixproapi import threadfixpro |
| 28 | + |
| 29 | + # setup threadfix connection information |
| 30 | + host = 'https://127.0.0.1:8443/threadfix/' |
| 31 | + api_key = 'your_api_key_from_threadfix_professional' |
| 32 | + |
| 33 | + # initialize threadfix pro api module |
| 34 | + tfp = threadfixpro.ThreadFixProAPI(host, api_key) |
| 35 | + |
| 36 | + # If you need to disable certificate verification. |
| 37 | + # tfp = threadfixpro.ThreadFixProAPI(host, api_key, verify_ssl=False) |
| 38 | + |
| 39 | + # List your threadfix pro teams |
| 40 | + teams = tfp.list_teams() |
| 41 | + if teams.success: |
| 42 | + print("{}".format(teams.data)) |
| 43 | + |
| 44 | + for team in teams.data: |
| 45 | + print(team['name']) # Print the name of each team |
| 46 | + else: |
| 47 | + print("ERROR: {}".format(teams.message)) |
| 48 | + |
| 49 | +Supporting information for each method available can be found in the `documentation <https://target.github.io/threadfixapi/>`__. |
| 50 | + |
| 51 | +Bugs and Feature Requests |
| 52 | +~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 53 | + |
| 54 | +Found something that doesn't seem right or have a feature request? `Please open a new issue <https://github.com/denimgroup/threadfix-python-api/issues/new>`__. |
| 55 | + |
| 56 | +Copyright and License |
| 57 | +~~~~~~~~~~~~~~~~~~~~~ |
| 58 | +.. image:: https://img.shields.io/github/license/target/threadfixproapi.svg?style=flat-square |
| 59 | + |
| 60 | +- Copyright 2020 Denim Group, Ltd. (based upon work by Target Brands, Inc.) |
0 commit comments