Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md + development md #93

Merged
merged 6 commits into from
Nov 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Lint
To start lint your code, simply run
```shell
npm run lint
```

## License
Copyright 2024 SkywardAI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,6 @@ make dev
```
**NOTE:** `make dev` Requires Node.js environment installed, or at least have `node_modules` specified in `package.json` installed on your server. Please see [Local Machine](#local-machine) section.

## Lint
To start lint your code, simply run
```shell
npm run lint
```

## APIs

Expand Down
14 changes: 14 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,17 @@ example/test_apis.py::TestAllAPIs::test_inference_by_request_stream PASSED

## Api Test
![Successful Running example](img/api_test.png)

## License
Copyright 2024 SkywardAI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
8 changes: 7 additions & 1 deletion example/test_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,10 @@ def test_version_api(self):
res = requests.get(url=self.base_url+"/v1/version")
self.assertEqual(res.status_code, 200)
data = res.json().get("inference_engine_version")
self.assertEqual('server--b1-27d4b7c', data)
self.assertEqual('server--b1-27d4b7c', data)
def test_invalid_api_key(self):
res = requests.get(url=self.base_url+"/v1/token/api-key", headers={"Authorization": "Bearer invalid-key"})
self.assertEqual(res.status_code, 401)
def test_invalid_endpoint(self):
res=requests.get(url=self.base_url+"/v1/invalid-endpoint")
self.assertEqual(res.status_code, 404)
Loading