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.6.0
- Package version: 0.6.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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# 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)
user_api_key_create_request = avis_client.UserAPIKeyCreateRequest() # UserAPIKeyCreateRequest | (optional)
try:
api_response = api_instance.keys_create(user_api_key_create_request=user_api_key_create_request)
print("The response of ApiKeysApi->keys_create:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiKeysApi->keys_create: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://avis.vu.engineering
Class | Method | HTTP request | Description |
---|---|---|---|
ApiKeysApi | keys_create | POST /api/keys/ | |
ApiKeysApi | keys_revoke_create | POST /api/keys/revoke/ | |
ConfigurationApi | configuration_create | POST /api/configuration/ | |
ConfigurationApi | configuration_destroy | DELETE /api/configuration/{id}/ | |
ConfigurationApi | configuration_list | GET /api/configuration/ | |
ConfigurationApi | configuration_partial_update | PATCH /api/configuration/{id}/ | |
ConfigurationApi | configuration_retrieve | GET /api/configuration/{id}/ | |
ConfigurationApi | configuration_update | PUT /api/configuration/{id}/ | |
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}/ | |
ImageAttributeApi | image_attribute_create | POST /api/image-attribute/ | |
ImageAttributeApi | image_attribute_destroy | DELETE /api/image-attribute/{id}/ | |
ImageAttributeApi | image_attribute_list | GET /api/image-attribute/ | |
ImageAttributeApi | image_attribute_partial_update | PATCH /api/image-attribute/{id}/ | |
ImageAttributeApi | image_attribute_retrieve | GET /api/image-attribute/{id}/ | |
ImageAttributeApi | image_attribute_update | PUT /api/image-attribute/{id}/ | |
ImageAttributeCategoryApi | image_attribute_category_create | POST /api/image-attribute-category/ | |
ImageAttributeCategoryApi | image_attribute_category_destroy | DELETE /api/image-attribute-category/{id}/ | |
ImageAttributeCategoryApi | image_attribute_category_list | GET /api/image-attribute-category/ | |
ImageAttributeCategoryApi | image_attribute_category_partial_update | PATCH /api/image-attribute-category/{id}/ | |
ImageAttributeCategoryApi | image_attribute_category_retrieve | GET /api/image-attribute-category/{id}/ | |
ImageAttributeCategoryApi | image_attribute_category_update | PUT /api/image-attribute-category/{id}/ | |
InspectionApi | inspection_create | POST /api/inspection/ | |
InspectionApi | inspection_destroy | DELETE /api/inspection/{id}/ | |
InspectionApi | inspection_list | GET /api/inspection/ | |
InspectionApi | inspection_partial_update | PATCH /api/inspection/{id}/ | |
InspectionApi | inspection_retrieve | GET /api/inspection/{id}/ | |
InspectionApi | inspection_send_validation_email_retrieve | GET /api/inspection/{id}/send_validation_email/ | |
InspectionApi | inspection_status_list | GET /api/inspection/status/ | |
InspectionApi | inspection_update | PUT /api/inspection/{id}/ | |
InspectionApi | inspection_validation_status_list | GET /api/inspection/validation_status/ | |
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}/ | |
MetadataApi | metadata_create | POST /api/metadata/ | |
MetadataApi | metadata_destroy | DELETE /api/metadata/{id}/ | |
MetadataApi | metadata_list | GET /api/metadata/ | |
MetadataApi | metadata_partial_update | PATCH /api/metadata/{id}/ | |
MetadataApi | metadata_retrieve | GET /api/metadata/{id}/ | |
MetadataApi | metadata_update | PUT /api/metadata/{id}/ | |
MetadataSchemaApi | metadata_schema_create | POST /api/metadata-schema/ | |
MetadataSchemaApi | metadata_schema_destroy | DELETE /api/metadata-schema/{id}/ | |
MetadataSchemaApi | metadata_schema_list | GET /api/metadata-schema/ | |
MetadataSchemaApi | metadata_schema_partial_update | PATCH /api/metadata-schema/{id}/ | |
MetadataSchemaApi | metadata_schema_retrieve | GET /api/metadata-schema/{id}/ | |
MetadataSchemaApi | metadata_schema_update | PUT /api/metadata-schema/{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}/ | |
ProductApi | product_create | POST /api/product/ | |
ProductApi | product_destroy | DELETE /api/product/{id}/ | |
ProductApi | product_list | GET /api/product/ | |
ProductApi | product_partial_update | PATCH /api/product/{id}/ | |
ProductApi | product_retrieve | GET /api/product/{id}/ | |
ProductApi | product_update | PUT /api/product/{id}/ | |
ProductCategoryApi | product_category_create | POST /api/product-category/ | |
ProductCategoryApi | product_category_destroy | DELETE /api/product-category/{id}/ | |
ProductCategoryApi | product_category_list | GET /api/product-category/ | |
ProductCategoryApi | product_category_partial_update | PATCH /api/product-category/{id}/ | |
ProductCategoryApi | product_category_retrieve | GET /api/product-category/{id}/ | |
ProductCategoryApi | product_category_update | PUT /api/product-category/{id}/ | |
QualityCriteriaApi | quality_criteria_create | POST /api/quality-criteria/ | |
QualityCriteriaApi | quality_criteria_destroy | DELETE /api/quality-criteria/{id}/ | |
QualityCriteriaApi | quality_criteria_list | GET /api/quality-criteria/ | |
QualityCriteriaApi | quality_criteria_partial_update | PATCH /api/quality-criteria/{id}/ | |
QualityCriteriaApi | quality_criteria_retrieve | GET /api/quality-criteria/{id}/ | |
QualityCriteriaApi | quality_criteria_update | PUT /api/quality-criteria/{id}/ | |
ResultApi | result_create | POST /api/result/ | |
ResultApi | result_destroy | DELETE /api/result/{id}/ | |
ResultApi | result_list | GET /api/result/ | |
ResultApi | result_partial_update | PATCH /api/result/{id}/ | |
ResultApi | result_retrieve | GET /api/result/{id}/ | |
ResultApi | result_update | PUT /api/result/{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
- BlankEnum
- ConfigurationType
- ConfigurationTypeRequest
- CustomUser
- CustomUserRequest
- EmailAddress
- FormatEnum
- Image
- ImageAttribute
- ImageAttributeCategory
- ImageAttributeCategoryRequest
- ImageAttributeRequest
- ImageRequest
- Inspection
- InspectionRequest
- InspectionStatus
- InspectionStatusEnum
- InspectionValidationStatus
- MLModel
- MLModelRequest
- MLModelType
- MLModelTypeRequest
- Membership
- MembershipRequest
- Metadata
- MetadataRequest
- MetadataSchema
- MetadataSchemaRequest
- PatchedConfigurationTypeRequest
- PatchedImageAttributeCategoryRequest
- PatchedImageAttributeRequest
- PatchedImageRequest
- PatchedInspectionRequest
- PatchedMLModelRequest
- PatchedMLModelTypeRequest
- PatchedMetadataRequest
- PatchedMetadataSchemaRequest
- PatchedProductCategoryRequest
- PatchedProductRequest
- PatchedQualityCriteriaRequest
- PatchedResultRequest
- PatchedResultRequestStatus
- Product
- ProductCategory
- ProductCategoryRequest
- ProductRequest
- QualityCriteria
- QualityCriteriaRequest
- QualityCriteriaResult
- QualityEnum
- Result
- ResultRequest
- StatusEnum
- Team
- TeamRequest
- UserAPIKeyCreate
- UserAPIKeyCreateRequest
- 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.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1fedb5a35539a782ccd9c95ebb2f92ea5ae631cb4a486cd871ac05f441140cb |
|
MD5 | 09645e369321d98db94ae51c9f74570a |
|
BLAKE2b-256 | 5b650f6b5ad3ef248687ac81abcd03d9fe9d43c1de77a6fdb278b4dee9846eb3 |