You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,19 @@ Collection of NLP APIs to help developers. We have grouped the APIs under Basic
7
7
8
8
### OpenAPI Specification
9
9
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
12
12
OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
13
13
14
14
## Building
15
15
16
+
Download the FirstLanguage Python SDK from <ahref="FirstLanguage_PythonSDK.zip">here</a>
17
+
16
18
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/).
17
19
18
20
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.
19
21
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.
21
23
* Run the command `pip install -r requirements.txt`. This should install all the required dependencies.
@@ -78,11 +80,11 @@ To run the file within your test project, right click on your Python file inside
78
80
79
81
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:
80
82
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
86
88
```
87
89
88
90
## Initialize the API Client
@@ -108,8 +110,8 @@ The API client can be initialized as follows:
108
110
from firstlanguageapi.firstlanguageapi_client import FirstlanguageapiClient
109
111
from firstlanguageapi.configuration import Environment
110
112
111
-
client = FirstlanguageapiClient(
112
-
apikey='apikey',
113
+
client = FirstlanguageapiClient(
114
+
apikey='apikey',
113
115
environment=Environment.PRODUCTION,)
114
116
```
115
117
@@ -119,12 +121,12 @@ This API uses `Custom Header Signature`.
119
121
120
122
## List of APIs
121
123
122
-
*[Basic AP Is](/doc/controllers/basic-ap-is.md)
124
+
*[Basic AP Is](/doc/controllers/basic-ap-is.md)
123
125
*[Advanced AP Is](/doc/controllers/advanced-ap-is.md)
0 commit comments