| Name | AOI-Package JSON |
| Version |
1.1.8
JSON |
| download |
| home_page | None |
| Summary | Automated Optical Inspection API |
| upload_time | 2025-01-03 15:41:19 |
| maintainer | None |
| docs_url | None |
| author | Corey Sadler |
| requires_python | >=3.4 |
| license | Copyright © 2024 3ADesign Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
openapi
openapi-generator
aoiapi
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AOI-API
AOI_API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.1
- Package version: 1.0.1
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen
## Requirements.
Python 2.7 and 3.4+
## 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 AOI_API
```
### 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 AOI_API
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import AOI_API
from AOI_API.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/AOIServer
# See configuration.py for a list of all supported configuration parameters.
configuration = AOI_API.Configuration(
host = "http://localhost/AOIServer"
)
# Enter a context with an instance of the API client
with AOI_API.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = AOI_API.AOIApi(api_client)
board_width = 3.4 # float | width of board to be scanned (optional)
board_length = 3.4 # float | length of board to be scanned (optional)
step_size = 3.4 # float | step size between images (optional)
try:
#
api_instance.post_scan_board(board_width=board_width, board_length=board_length, step_size=step_size)
except ApiException as e:
print("Exception when calling AOIApi->post_scan_board: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost/AOIServer*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AOIApi* | [**post_scan_board**](docs/AOIApi.md#post_scan_board) | **POST** /scan_board |
*AOIApi* | [**put_calibration**](docs/AOIApi.md#put_calibration) | **PUT** /calibrate |
## Documentation For Models
- [DbPhrameJSONStore](docs/DbPhrameJSONStore.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
corey.sadler@3adesign.co.uk
Raw data
{
"_id": null,
"home_page": null,
"name": "AOI-Package",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, AOIAPI",
"author": "Corey Sadler",
"author_email": "Corey Sadler <corey.sadler@3adesign.co.uk>, David Atkins <david@3adesign.co.uk>",
"download_url": null,
"platform": null,
"description": "# AOI-API\nAOI_API\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1\n- Package version: 1.0.1\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport AOI_API\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport AOI_API\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport AOI_API\nfrom AOI_API.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost/AOIServer\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = AOI_API.Configuration(\n host = \"http://localhost/AOIServer\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith AOI_API.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = AOI_API.AOIApi(api_client)\n board_width = 3.4 # float | width of board to be scanned (optional)\nboard_length = 3.4 # float | length of board to be scanned (optional)\nstep_size = 3.4 # float | step size between images (optional)\n\n try:\n # \n api_instance.post_scan_board(board_width=board_width, board_length=board_length, step_size=step_size)\n except ApiException as e:\n print(\"Exception when calling AOIApi->post_scan_board: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost/AOIServer*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AOIApi* | [**post_scan_board**](docs/AOIApi.md#post_scan_board) | **POST** /scan_board | \n*AOIApi* | [**put_calibration**](docs/AOIApi.md#put_calibration) | **PUT** /calibrate | \n\n\n## Documentation For Models\n\n - [DbPhrameJSONStore](docs/DbPhrameJSONStore.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\ncorey.sadler@3adesign.co.uk\n\n\n",
"bugtrack_url": null,
"license": "Copyright \u00a9 2024 3ADesign Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Automated Optical Inspection API",
"version": "1.1.8",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" aoiapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc38bdad8f721c458d3fafd889c86b0ded6713dce115a93bc02936a812ff438a",
"md5": "dae9854d12506f9b40f4b21e11fb3b8a",
"sha256": "1d5fd6f09af3d2d76d86e9a88b98012d724afc9b6245cc1da5730ef73af1bfda"
},
"downloads": -1,
"filename": "AOI_Package-1.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dae9854d12506f9b40f4b21e11fb3b8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 54514,
"upload_time": "2025-01-03T15:41:19",
"upload_time_iso_8601": "2025-01-03T15:41:19.118023Z",
"url": "https://files.pythonhosted.org/packages/cc/38/bdad8f721c458d3fafd889c86b0ded6713dce115a93bc02936a812ff438a/AOI_Package-1.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 15:41:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aoi-package"
}
