AVIS Python client
Project description
avis-client
VUE Autonomous Visual Inspection System (AVIS)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.3.0
- Package version: 0.3.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:
pip install git+https://github.com/vuengineering/public.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/vuengineering/public.git
)
Then import the package:
import avis_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import avis_client
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import avis_client
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://avis.vu.engineering
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "https://avis.vu.engineering"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.ApiKeysApi(api_client)
credentials_request = avis_client.CredentialsRequest() # CredentialsRequest |
try:
api_response = api_instance.api_key_create(credentials_request)
print("The response of ApiKeysApi->api_key_create:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiKeysApi->api_key_create: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://avis.vu.engineering
Class | Method | HTTP request | Description |
---|---|---|---|
ApiKeysApi | api_key_create | POST /api/api-keys/ | |
ApiKeysApi | api_key_revoke | POST /api/api-keys/{id}/revoke/ | |
CaseApi | case_create | POST /api/case/ | |
CaseApi | case_destroy | DELETE /api/case/{id}/ | |
CaseApi | case_inspection_status_list | GET /api/case/inspection_status/ | |
CaseApi | case_list | GET /api/case/ | |
CaseApi | case_partial_update | PATCH /api/case/{id}/ | |
CaseApi | case_retrieve | GET /api/case/{id}/ | |
CaseApi | case_send_validation_email_retrieve | GET /api/case/{id}/send_validation_email/ | |
CaseApi | case_update | PUT /api/case/{id}/ | |
CaseApi | case_validation_status_list | GET /api/case/validation_status/ | |
ImageApi | image_create | POST /api/image/ | |
ImageApi | image_destroy | DELETE /api/image/{id}/ | |
ImageApi | image_inspection_status_list | GET /api/image/inspection_status/ | |
ImageApi | image_list | GET /api/image/ | |
ImageApi | image_partial_update | PATCH /api/image/{id}/ | |
ImageApi | image_quality_list | GET /api/image/quality/ | |
ImageApi | image_retrieve | GET /api/image/{id}/ | |
ImageApi | image_update | PUT /api/image/{id}/ | |
ImagequalitygateApi | imagequalitygate_create | POST /api/imagequalitygate/ | |
ImagequalitygateApi | imagequalitygate_destroy | DELETE /api/imagequalitygate/{id}/ | |
ImagequalitygateApi | imagequalitygate_list | GET /api/imagequalitygate/ | |
ImagequalitygateApi | imagequalitygate_partial_update | PATCH /api/imagequalitygate/{id}/ | |
ImagequalitygateApi | imagequalitygate_retrieve | GET /api/imagequalitygate/{id}/ | |
ImagequalitygateApi | imagequalitygate_update | PUT /api/imagequalitygate/{id}/ | |
InspectionmetadataApi | inspectionmetadata_create | POST /api/inspectionmetadata/ | |
InspectionmetadataApi | inspectionmetadata_destroy | DELETE /api/inspectionmetadata/{id}/ | |
InspectionmetadataApi | inspectionmetadata_list | GET /api/inspectionmetadata/ | |
InspectionmetadataApi | inspectionmetadata_partial_update | PATCH /api/inspectionmetadata/{id}/ | |
InspectionmetadataApi | inspectionmetadata_retrieve | GET /api/inspectionmetadata/{id}/ | |
InspectionmetadataApi | inspectionmetadata_update | PUT /api/inspectionmetadata/{id}/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_create | POST /api/inspectionmetadataschema/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_destroy | DELETE /api/inspectionmetadataschema/{id}/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_list | GET /api/inspectionmetadataschema/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_partial_update | PATCH /api/inspectionmetadataschema/{id}/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_retrieve | GET /api/inspectionmetadataschema/{id}/ | |
InspectionmetadataschemaApi | inspectionmetadataschema_update | PUT /api/inspectionmetadataschema/{id}/ | |
InspectionobjectApi | inspectionobject_create | POST /api/inspectionobject/ | |
InspectionobjectApi | inspectionobject_destroy | DELETE /api/inspectionobject/{id}/ | |
InspectionobjectApi | inspectionobject_list | GET /api/inspectionobject/ | |
InspectionobjectApi | inspectionobject_partial_update | PATCH /api/inspectionobject/{id}/ | |
InspectionobjectApi | inspectionobject_retrieve | GET /api/inspectionobject/{id}/ | |
InspectionobjectApi | inspectionobject_update | PUT /api/inspectionobject/{id}/ | |
InspectionobjecttypeApi | inspectionobjecttype_create | POST /api/inspectionobjecttype/ | |
InspectionobjecttypeApi | inspectionobjecttype_destroy | DELETE /api/inspectionobjecttype/{id}/ | |
InspectionobjecttypeApi | inspectionobjecttype_list | GET /api/inspectionobjecttype/ | |
InspectionobjecttypeApi | inspectionobjecttype_partial_update | PATCH /api/inspectionobjecttype/{id}/ | |
InspectionobjecttypeApi | inspectionobjecttype_retrieve | GET /api/inspectionobjecttype/{id}/ | |
InspectionobjecttypeApi | inspectionobjecttype_update | PUT /api/inspectionobjecttype/{id}/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_create | POST /api/inspectionprocessblueprint/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_destroy | DELETE /api/inspectionprocessblueprint/{id}/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_list | GET /api/inspectionprocessblueprint/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_partial_update | PATCH /api/inspectionprocessblueprint/{id}/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_retrieve | GET /api/inspectionprocessblueprint/{id}/ | |
InspectionprocessblueprintApi | inspectionprocessblueprint_update | PUT /api/inspectionprocessblueprint/{id}/ | |
InspectionresultApi | inspectionresult_create | POST /api/inspectionresult/ | |
InspectionresultApi | inspectionresult_destroy | DELETE /api/inspectionresult/{id}/ | |
InspectionresultApi | inspectionresult_list | GET /api/inspectionresult/ | |
InspectionresultApi | inspectionresult_partial_update | PATCH /api/inspectionresult/{id}/ | |
InspectionresultApi | inspectionresult_retrieve | GET /api/inspectionresult/{id}/ | |
InspectionresultApi | inspectionresult_update | PUT /api/inspectionresult/{id}/ | |
MembershipApi | membership_create | POST /api/membership/ | |
MembershipApi | membership_destroy | DELETE /api/membership/{id}/ | |
MembershipApi | membership_list | GET /api/membership/ | |
MembershipApi | membership_retrieve | GET /api/membership/{id}/ | |
MembershipApi | membership_update | PUT /api/membership/{id}/ | |
MlApi | ml_inspectionresult_create | POST /api/ml/inspectionresult/ | |
MlApi | ml_inspectionresult_destroy | DELETE /api/ml/inspectionresult/{id}/ | |
MlApi | ml_inspectionresult_list | GET /api/ml/inspectionresult/ | |
MlApi | ml_inspectionresult_partial_update | PATCH /api/ml/inspectionresult/{id}/ | |
MlApi | ml_inspectionresult_retrieve | GET /api/ml/inspectionresult/{id}/ | |
MlApi | ml_inspectionresult_update | PUT /api/ml/inspectionresult/{id}/ | |
MlApi | ml_model_create | POST /api/ml/model/ | |
MlApi | ml_model_destroy | DELETE /api/ml/model/{id}/ | |
MlApi | ml_model_inference | POST /api/ml/model/{id}/inference/ | |
MlApi | ml_model_list | GET /api/ml/model/ | |
MlApi | ml_model_partial_update | PATCH /api/ml/model/{id}/ | |
MlApi | ml_model_retrieve | GET /api/ml/model/{id}/ | |
MlApi | ml_model_update | PUT /api/ml/model/{id}/ | |
MlApi | ml_modeltype_create | POST /api/ml/modeltype/ | |
MlApi | ml_modeltype_destroy | DELETE /api/ml/modeltype/{id}/ | |
MlApi | ml_modeltype_list | GET /api/ml/modeltype/ | |
MlApi | ml_modeltype_partial_update | PATCH /api/ml/modeltype/{id}/ | |
MlApi | ml_modeltype_retrieve | GET /api/ml/modeltype/{id}/ | |
MlApi | ml_modeltype_update | PUT /api/ml/modeltype/{id}/ | |
TeamApi | team_create | POST /api/team/ | |
TeamApi | team_destroy | DELETE /api/team/{id}/ | |
TeamApi | team_list | GET /api/team/ | |
TeamApi | team_retrieve | GET /api/team/{id}/ | |
TeamApi | team_update | PUT /api/team/{id}/ | |
UserApi | user_email_list | GET /api/user/email/ | |
UserApi | user_whoami_retrieve | GET /api/user/whoami/ |
Documentation For Models
- AzureMLInferenceRequest
- BinaryClassEnum
- BinaryClassInspectionResult
- BinaryClassInspectionResultRequest
- BinaryClassInspectionResultTyped
- BinaryClassInspectionResultTypedRequest
- BlankEnum
- Case
- CaseRequest
- CaseValidationStatus
- ClassificationResult
- ClassificationResultRequest
- ClassificationResultStatus
- CredentialsRequest
- CustomUser
- CustomUserRequest
- EmailAddress
- FormatEnum
- Image
- ImageQualityGate
- ImageQualityGateRequest
- ImageQualityGateResult
- ImageRequest
- InspectionMetadata
- InspectionMetadataRequest
- InspectionMetadataSchema
- InspectionMetadataSchemaRequest
- InspectionObject
- InspectionObjectRequest
- InspectionObjectType
- InspectionObjectTypeRequest
- InspectionProcessBlueprint
- InspectionProcessBlueprintRequest
- InspectionResultPolymorphic
- InspectionResultPolymorphicRequest
- InspectionStatus
- InspectionStatusEnum
- MLModel
- MLModelRequest
- MLModelType
- MLModelTypeRequest
- Membership
- MembershipRequest
- PatchedBinaryClassInspectionResultRequest
- PatchedBinaryClassInspectionResultTypedRequest
- PatchedCaseRequest
- PatchedClassificationResultRequest
- PatchedImageQualityGateRequest
- PatchedImageRequest
- PatchedInspectionMetadataRequest
- PatchedInspectionMetadataSchemaRequest
- PatchedInspectionObjectRequest
- PatchedInspectionObjectTypeRequest
- PatchedInspectionProcessBlueprintRequest
- PatchedInspectionResultPolymorphicRequest
- PatchedMLModelRequest
- PatchedMLModelTypeRequest
- PatchedRatingInspectionResultRequest
- PatchedRatingInspectionResultTypedRequest
- QualityEnum
- RatingInspectionResult
- RatingInspectionResultRequest
- RatingInspectionResultTyped
- RatingInspectionResultTypedRequest
- StatusEnum
- Team
- TeamRequest
- TypeEnum
- UserAPIKeyCreate
- ValidationStatusEnum
Documentation For Authorization
Authentication schemes defined for the API:
ApiKeyAuth
- Type: API key
- API key parameter name: X-Api-Key
- Location: HTTP header
cookieAuth
- Type: API key
- API key parameter name: sessionid
- Location:
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for avis_client-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8e5fd293418d404a67fe2e40ad7e471fd1c2593a86434dfc826ddc362450fbb |
|
MD5 | 483be94a013aeefc64c17520515510d4 |
|
BLAKE2b-256 | 44c61d72ff4dad8bfee170778aaeca932bc271b2bc174460f55cbfe1360cebb1 |