An API for securitytext.org
How to Build
You must have Python
2 >=2.7.9 or Python
3 >=3.4 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc.
These dependencies are defined in the
requirements.txt file that comes with the SDK.
To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.
Python and PIP executables should be defined in your PATH. Open command prompt and type
This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.
- Using command line, navigate to the directory containing the generated files (including
requirements.txt) for the SDK.
- Run the command
pip install -r requirements.txt. This should install all the required dependencies.
How to Use
The following section explains how to use the Securitytextorgapi SDK package in a new project.
1. Open Project in an IDE
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Open in PyCharm to browse to your generated SDK directory and then click
The project files will be displayed in the side bar as follows:
2. Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a python file to this project with the name "testsdk"
Name it "testsdk"
In your python file you will be required to import the generated python library using the following code lines
from securitytextorgapi.securitytextorgapi_client import SecuritytextorgapiClient
After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.
3. Run the Test Project
To run the file within your test project, right click on your Python file inside your Test project and click on
How to Test
You can test the generated SDK and the server with automatically generated test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:
- From terminal/cmd navigate to the root directory of the SDK.
pip install -r test-requirements.txt
API client can be initialized as following.
client = SecuritytextorgapiClient()
Get controller instance
An instance of the
WhoisController class can be accessed from the API Client.
whois_controller = client.whois
Query the server for a Domain object
def create_api_whois_query(self, body)
||Body of API request|
body = RequestsQueryModel() result = whois_controller.create_api_whois_query(body)
|Error Code||Error Description|
|500||Internal Server Error|