Skip to content

Commit 41b9bc3

Browse files
author
Dan Cornell
committed
Fixed package naming to be consistent with the original
Cleaned up packaging
1 parent d553ab2 commit 41b9bc3

5 files changed

Lines changed: 64 additions & 8 deletions

File tree

README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
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.)

setup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
import setuptools
12
from distutils.core import setup
23

34
setup(
4-
name='ThreadFixPythonAPI',
5-
version='1.0.7',
6-
packages=['ThreadFixPythonApi', '_utils',],
5+
name='ThreadFixProAPI',
6+
version='1.0.8',
7+
packages=['ThreadFixProApi', '_utils',],
78
license='MIT',
89
long_description='A python implementation of ThreadFix\'s API for easier use with python. Built off of original work by (c) 2018 Target Brands, Inc.'
910
)

0 commit comments

Comments
 (0)