Skip to content
This repository has been archived by the owner on Mar 30, 2024. It is now read-only.

Commit

Permalink
add openapi client
Browse files Browse the repository at this point in the history
  • Loading branch information
sethlxk committed Feb 13, 2024
1 parent 7d9c8c1 commit b82022b
Show file tree
Hide file tree
Showing 98 changed files with 7,556 additions and 55 deletions.
File renamed without changes.
79 changes: 59 additions & 20 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,27 +1,66 @@
.idea
.gradle
**/build/
!src/**/build/
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Ignore Gradle GUI config
gradle-app.setting
# C extensions
*.so

# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
!gradle-wrapper.jar
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# Avoid ignore Gradle wrappper properties
!gradle-wrapper.properties
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Cache of project
.gradletasknamecache
# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Eclipse Gradle plugin generated files
# Eclipse Core
.project
# JDT-specific (Eclipse Java Development Tools)
.classpath
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
venv/
.venv/
.python-version
.pytest_cache

**/__pycache__/
# Translations
*.mo
*.pot

*.iml
/service/.venv/
# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

#Ipython Notebook
.ipynb_checkpoints
31 changes: 31 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# NOTE: This file is auto generated by OpenAPI Generator.
# URL: https://openapi-generator.tech
#
# ref: https://docs.gitlab.com/ee/ci/README.html
# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml

stages:
- test

.pytest:
stage: test
script:
- pip install -r requirements.txt
- pip install -r test-requirements.txt
- pytest --cov=openapi_client

pytest-3.7:
extends: .pytest
image: python:3.7-alpine
pytest-3.8:
extends: .pytest
image: python:3.8-alpine
pytest-3.9:
extends: .pytest
image: python:3.9-alpine
pytest-3.10:
extends: .pytest
image: python:3.10-alpine
pytest-3.11:
extends: .pytest
image: python:3.11-alpine
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
92 changes: 92 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.github/workflows/python.yml
.gitignore
.gitlab-ci.yml
.openapi-generator-ignore
.travis.yml
README.md
docs/Cost.md
docs/Direction.md
docs/ErrorContext.md
docs/ErrorType.md
docs/ImagePredictionResponse.md
docs/ImageRecognitionApi.md
docs/Location.md
docs/Message.md
docs/MiscInstruction.md
docs/Move.md
docs/Path.md
docs/PathfindingApi.md
docs/PathfindingPoint.md
docs/PathfindingRequest.md
docs/PathfindingRequestObstacle.md
docs/PathfindingRequestRobot.md
docs/PathfindingResponse.md
docs/PathfindingResponseMoveInstruction.md
docs/PathfindingResponseSegment.md
docs/PathfindingResponseSegmentInstructionsInner.md
docs/PathfindingVector.md
docs/TurnInstruction.md
docs/ValidationErrorModel.md
git_push.sh
openapi_client/__init__.py
openapi_client/api/__init__.py
openapi_client/api/image_recognition_api.py
openapi_client/api/pathfinding_api.py
openapi_client/api_client.py
openapi_client/api_response.py
openapi_client/configuration.py
openapi_client/exceptions.py
openapi_client/models/__init__.py
openapi_client/models/cost.py
openapi_client/models/direction.py
openapi_client/models/error_context.py
openapi_client/models/error_type.py
openapi_client/models/image_prediction_response.py
openapi_client/models/location.py
openapi_client/models/message.py
openapi_client/models/misc_instruction.py
openapi_client/models/move.py
openapi_client/models/path.py
openapi_client/models/pathfinding_point.py
openapi_client/models/pathfinding_request.py
openapi_client/models/pathfinding_request_obstacle.py
openapi_client/models/pathfinding_request_robot.py
openapi_client/models/pathfinding_response.py
openapi_client/models/pathfinding_response_move_instruction.py
openapi_client/models/pathfinding_response_segment.py
openapi_client/models/pathfinding_response_segment_instructions_inner.py
openapi_client/models/pathfinding_vector.py
openapi_client/models/turn_instruction.py
openapi_client/models/validation_error_model.py
openapi_client/py.typed
openapi_client/rest.py
pyproject.toml
requirements.txt
setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_cost.py
test/test_direction.py
test/test_error_context.py
test/test_error_type.py
test/test_image_prediction_response.py
test/test_image_recognition_api.py
test/test_location.py
test/test_message.py
test/test_misc_instruction.py
test/test_move.py
test/test_path.py
test/test_pathfinding_api.py
test/test_pathfinding_point.py
test/test_pathfinding_request.py
test/test_pathfinding_request_obstacle.py
test/test_pathfinding_request_robot.py
test/test_pathfinding_response.py
test/test_pathfinding_response_move_instruction.py
test/test_pathfinding_response_segment.py
test/test_pathfinding_response_segment_instructions_inner.py
test/test_pathfinding_vector.py
test/test_turn_instruction.py
test/test_validation_error_model.py
tox.ini
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.3.0
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.7"
- "3.8"
- "3.9"
- "3.10"
- "3.11"
# uncomment the following if needed
#- "3.11-dev" # 3.11 development branch
#- "nightly" # nightly build
# command to install dependencies
install:
- "pip install -r requirements.txt"
- "pip install -r test-requirements.txt"
# command to run tests
script: pytest --cov=openapi_client
131 changes: 130 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,130 @@
# CZ3004-SC2079-MDP-GROUP 14
# CZ3004-SC2079-MDP-GROUP 14


# openapi-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import openapi_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import openapi_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.ImageRecognitionApi(api_client)
file = None # bytearray |

try:
api_response = api_instance.image_prediction_task1_post(file)
print("The response of ImageRecognitionApi->image_prediction_task1_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ImageRecognitionApi->image_prediction_task1_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ImageRecognitionApi* | [**image_prediction_task1_post**](docs/ImageRecognitionApi.md#image_prediction_task1_post) | **POST** /image/prediction/task-1 |
*ImageRecognitionApi* | [**image_prediction_task2_post**](docs/ImageRecognitionApi.md#image_prediction_task2_post) | **POST** /image/prediction/task-2 |
*ImageRecognitionApi* | [**image_stitch_post**](docs/ImageRecognitionApi.md#image_stitch_post) | **POST** /image/stitch |
*PathfindingApi* | [**pathfinding_post**](docs/PathfindingApi.md#pathfinding_post) | **POST** /pathfinding/ |


## Documentation For Models

- [Cost](docs/Cost.md)
- [Direction](docs/Direction.md)
- [ErrorContext](docs/ErrorContext.md)
- [ErrorType](docs/ErrorType.md)
- [ImagePredictionResponse](docs/ImagePredictionResponse.md)
- [Location](docs/Location.md)
- [Message](docs/Message.md)
- [MiscInstruction](docs/MiscInstruction.md)
- [Move](docs/Move.md)
- [Path](docs/Path.md)
- [PathfindingPoint](docs/PathfindingPoint.md)
- [PathfindingRequest](docs/PathfindingRequest.md)
- [PathfindingRequestObstacle](docs/PathfindingRequestObstacle.md)
- [PathfindingRequestRobot](docs/PathfindingRequestRobot.md)
- [PathfindingResponse](docs/PathfindingResponse.md)
- [PathfindingResponseMoveInstruction](docs/PathfindingResponseMoveInstruction.md)
- [PathfindingResponseSegment](docs/PathfindingResponseSegment.md)
- [PathfindingResponseSegmentInstructionsInner](docs/PathfindingResponseSegmentInstructionsInner.md)
- [PathfindingVector](docs/PathfindingVector.md)
- [TurnInstruction](docs/TurnInstruction.md)
- [ValidationErrorModel](docs/ValidationErrorModel.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




Loading

0 comments on commit b82022b

Please sign in to comment.