Skip to content

Commit aba98d4

Browse files
committed
Download link
1 parent 0ebab5a commit aba98d4

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

FirstLanguage_PythonSDK.zip

35.6 KB
Binary file not shown.

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ Collection of NLP APIs to help developers. We have grouped the APIs under Basic
77

88
### OpenAPI Specification
99

10-
This API is documented in **OpenAPI v3.0 format**.
11-
In addition to standard
10+
This API is documented in **OpenAPI v3.0 format**.
11+
In addition to standard
1212
OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
1313

1414
## Building
1515

16+
Download the FirstLanguage Python SDK from <a href="FirstLanguage_PythonSDK.zip">here</a>
17+
1618
You must have Python `3 >=3.7, <= 3.9` 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/](https://pip.pypa.io/en/stable/installing/).
1719

1820
Python and PIP executables should be defined in your PATH. Open command prompt and type `pip --version`. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.
1921

20-
* Using command line, navigate to the directory containing the generated files (including `requirements.txt`) for the SDK.
22+
* Using command line, navigate to the directory containing the generated files (including `requirements.txt`) for the SDK.
2123
* Run the command `pip install -r requirements.txt`. This should install all the required dependencies.
2224

2325
![Building SDK - Step 1](https://apidocs.io/illustration/python?workspaceFolder=Firstlanguageapi-Python&step=installDependencies)
@@ -78,11 +80,11 @@ To run the file within your test project, right click on your Python file inside
7880

7981
You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `nose` is used as the test runner. You can run the tests as follows:
8082

81-
Navigate to the root directory of the SDK and run the following commands
82-
83-
```
84-
pip install -r test-requirements.txt
85-
nosetests
83+
Navigate to the root directory of the SDK and run the following commands
84+
85+
```
86+
pip install -r test-requirements.txt
87+
nosetests
8688
```
8789

8890
## Initialize the API Client
@@ -108,8 +110,8 @@ The API client can be initialized as follows:
108110
from firstlanguageapi.firstlanguageapi_client import FirstlanguageapiClient
109111
from firstlanguageapi.configuration import Environment
110112

111-
client = FirstlanguageapiClient(
112-
apikey='apikey',
113+
client = FirstlanguageapiClient(
114+
apikey='apikey',
113115
environment=Environment.PRODUCTION,)
114116
```
115117

@@ -119,12 +121,12 @@ This API uses `Custom Header Signature`.
119121

120122
## List of APIs
121123

122-
* [Basic AP Is](/doc/controllers/basic-ap-is.md)
124+
* [Basic AP Is](/doc/controllers/basic-ap-is.md)
123125
* [Advanced AP Is](/doc/controllers/advanced-ap-is.md)
124126

125127
## Classes Documentation
126128

127-
* [Utility Classes](/doc/utility-classes.md)
128-
* [HttpResponse](/doc/http-response.md)
129+
* [Utility Classes](/doc/utility-classes.md)
130+
* [HttpResponse](/doc/http-response.md)
129131
* [HttpRequest](/doc/http-request.md)
130132

0 commit comments

Comments
 (0)