# geoapi-client
Geospatial API for TAPIS
- API version: 0.1
- Package version: 2.10
- Build package: io.swagger.codegen.languages.PythonClientCodegen
For more information about the [GeoAPI](https://github.com/TACC-Cloud/geoap) and how this client is generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen), visit https://github.com/TACC-Cloud/geoap .
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
The python package can be found at [PyPi](https://pypi.org/project/geoapi-client/)
```sh
pip install geoapi-client --user
```
Then import the package:
```python
import geoapi_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import geoapi_client
from geoapi_client.rest import ApiException
from pprint import pprint
configuration = geoapi_client.Configuration()
configuration.host = MY_HOST # e.g. https://agave.designsafe-ci.org/geo/v2
configuration.api_key_prefix['Authorization'] = 'Bearer'
configuration.api_key['Authorization'] = TOKEN
api_client = geoapi_client.ApiClient(configuration)
api_instance = geoapi_client.ProjectsApi(api_client=api_client)
try:
project = api_instance.create_project(payload={"name": "My project"})
pprint(project)
features = api_instance.upload_file(project.id, 'image.jpg')
pprint(features)
except ApiException as e:
print("Exception: %s\n" % e)
```
## API Endpoints
All URIs are relative to *https://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*NotificationsApi* | **delete** | **DELETE** /notifications/progress |
*NotificationsApi* | **delete_0** | **DELETE** /notifications/progress/{progressUUID} |
*NotificationsApi* | **get** | **GET** /notifications/ |
*NotificationsApi* | **get_0** | **GET** /notifications/progress |
*NotificationsApi* | **get_1** | **GET** /notifications/progress/{progressUUID} |
*ProjectsApi* | **add_feature_asset** | **POST** /projects/{projectId}/features/{featureId}/assets/ |
*ProjectsApi* | **add_geo_json_feature** | **POST** /projects/{projectId}/features/ |
*ProjectsApi* | **add_overlay** | **POST** /projects/{projectId}/overlays/ |
*ProjectsApi* | **add_point_cloud** | **POST** /projects/{projectId}/point-cloud/ |
*ProjectsApi* | **add_streetview_sequence_to_feature** | **POST** /projects/{projectId}/streetview/ |
*ProjectsApi* | **add_tile_server** | **POST** /projects/{projectId}/tile-servers/ |
*ProjectsApi* | **add_user** | **POST** /projects/{projectId}/users/ |
*ProjectsApi* | **cluster_features** | **GET** /projects/{projectId}/features/cluster/{numClusters}/ |
*ProjectsApi* | **create_project** | **POST** /projects/ |
*ProjectsApi* | **delete_feature** | **DELETE** /projects/{projectId}/features/{featureId}/ |
*ProjectsApi* | **delete_point_cloud** | **DELETE** /projects/{projectId}/point-cloud/{pointCloudId}/ |
*ProjectsApi* | **delete_project** | **DELETE** /projects/{projectId}/ |
*ProjectsApi* | **get_all_features** | **GET** /projects/{projectId}/features/ |
*ProjectsApi* | **get_all_point_clouds** | **GET** /projects/{projectId}/point-cloud/ |
*ProjectsApi* | **get_feature** | **GET** /projects/{projectId}/features/{featureId}/ |
*ProjectsApi* | **get_overlays** | **GET** /projects/{projectId}/overlays/ |
*ProjectsApi* | **get_point_cloud** | **GET** /projects/{projectId}/point-cloud/{pointCloudId}/ |
*ProjectsApi* | **get_project_by_id** | **GET** /projects/{projectId}/ |
*ProjectsApi* | **get_project_users_resource** | **GET** /projects/{projectId}/users/ |
*ProjectsApi* | **get_projects** | **GET** /projects/ |
*ProjectsApi* | **get_streetview_sequence_from_feature** | **GET** /projects/{projectId}/streetview/{featureId}/ |
*ProjectsApi* | **get_tasks** | **GET** /projects/{projectId}/tasks/ |
*ProjectsApi* | **get_tile_servers** | **GET** /projects/{projectId}/tile-servers/ |
*ProjectsApi* | **import_file_from_tapis** | **POST** /projects/{projectId}/features/files/import/ |
*ProjectsApi* | **import_overlay_from_tapis** | **POST** /projects/{projectId}/overlays/import/ |
*ProjectsApi* | **import_point_cloud_file_from_tapis** | **POST** /projects/{projectId}/point-cloud/{pointCloudId}/import/ |
*ProjectsApi* | **remove_overlay** | **DELETE** /projects/{projectId}/overlays/{overlayId}/ |
*ProjectsApi* | **remove_tile_server** | **DELETE** /projects/{projectId}/tile-servers/{tileServerId}/ |
*ProjectsApi* | **remove_user** | **DELETE** /projects/{projectId}/users/{username}/ |
*ProjectsApi* | **update_feature_properties** | **POST** /projects/{projectId}/features/{featureId}/properties/ |
*ProjectsApi* | **update_feature_styles** | **POST** /projects/{projectId}/features/{featureId}/styles/ |
*ProjectsApi* | **update_point_c_loud** | **PUT** /projects/{projectId}/point-cloud/{pointCloudId}/ |
*ProjectsApi* | **update_project** | **PUT** /projects/{projectId}/ |
*ProjectsApi* | **update_tile_server** | **PUT** /projects/{projectId}/tile-servers/{tileServerId}/ |
*ProjectsApi* | **update_tile_servers** | **PUT** /projects/{projectId}/tile-servers/ |
*ProjectsApi* | **upload_file** | **POST** /projects/{projectId}/features/files/ |
*ProjectsApi* | **upload_point_cloud** | **POST** /projects/{projectId}/point-cloud/{pointCloudId}/ | :raises InvalidCoordinateReferenceSystem: in case file missing coordinate reference system
*PublicProjectsApi* | **get_all_features** | **GET** /public-projects/{projectId}/features/ |
*PublicProjectsApi* | **get_all_point_clouds** | **GET** /public-projects/{projectId}/point-cloud/ |
*PublicProjectsApi* | **get_feature** | **GET** /public-projects/{projectId}/features/{featureId}/ |
*PublicProjectsApi* | **get_overlays** | **GET** /public-projects/{projectId}/overlays/ |
*PublicProjectsApi* | **get_point_cloud** | **GET** /public-projects/{projectId}/point-cloud/{pointCloudId}/ |
*PublicProjectsApi* | **get_project_by_id** | **GET** /public-projects/{projectId}/ |
*PublicProjectsApi* | **get_projects** | **GET** /public-projects/ |
*PublicProjectsApi* | **get_tile_servers** | **GET** /public-projects/{projectId}/tile-servers/ |
*StreetviewApi* | **add_streetview_sequence** | **POST** /streetview/sequences/ |
*StreetviewApi* | **create_streetview_organizations** | **POST** /streetview/services/{service}/organization/ |
*StreetviewApi* | **create_streetview_service_resource** | **POST** /streetview/services/ |
*StreetviewApi* | **delete_streetview_instance** | **DELETE** /streetview/instances/{instance_id}/ |
*StreetviewApi* | **delete_streetview_organization** | **DELETE** /streetview/services/{service}/organization/{organization_id}/ |
*StreetviewApi* | **delete_streetview_sequence** | **DELETE** /streetview/sequences/{sequence_id}/ |
*StreetviewApi* | **delete_streetview_service_resource** | **DELETE** /streetview/services/{service}/ |
*StreetviewApi* | **get_streetview_organizations** | **GET** /streetview/services/{service}/organization/ |
*StreetviewApi* | **get_streetview_sequence** | **GET** /streetview/sequences/{sequence_id}/ |
*StreetviewApi* | **get_streetview_service_resource** | **GET** /streetview/services/{service}/ |
*StreetviewApi* | **get_streetview_service_resources** | **GET** /streetview/services/ |
*StreetviewApi* | **publish_files_to_streetview** | **POST** /streetview/publish/ |
*StreetviewApi* | **update_streetview_organization** | **PUT** /streetview/services/{service}/organization/{organization_id}/ |
*StreetviewApi* | **update_streetview_sequence** | **PUT** /streetview/sequences/{sequence_id}/ |
*StreetviewApi* | **update_streetview_service_resource** | **PUT** /streetview/services/{service}/ |
## Models
- Asset
- Feature
- FeatureCollection
- NotificationResponse
- OkResponse
- Overlay
- Payload
- PointCloud
- ProgressNotificationResponse
- Project
- Streetview
- StreetviewInstance
- StreetviewOrganization
- StreetviewParams
- StreetviewSequence
- TapisFile
- TapisFileImport
- TapisFileUpload
- TapisFolderImport
- Task
- TileServer
- User
- UserPayload
## Documentation For Authorization
## JWT
- **Type**: API key
- **API key parameter name**: X-JWT-Assertion-designsafe
- **Location**: HTTP header
## Token
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
Texas Advanced Computing Center
CICsupport@tacc.utexas.edu
Raw data
{
"_id": null,
"home_page": "https://github.com/TACC-Cloud/geoapi",
"name": "geoapi-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "TACC,GeoAPI",
"author": "Texas Advanced Computing Center",
"author_email": "CICsupport@tacc.utexas.edu",
"download_url": "https://files.pythonhosted.org/packages/3a/c4/33437877f59f149c2bbff4855e2c4f19e9a07a20792948450997e8046496/geoapi-client-2.10.tar.gz",
"platform": null,
"description": "# geoapi-client\nGeospatial API for TAPIS\n\n\n- API version: 0.1\n- Package version: 2.10\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\nFor more information about the [GeoAPI](https://github.com/TACC-Cloud/geoap) and how this client is generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen), visit https://github.com/TACC-Cloud/geoap .\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nThe python package can be found at [PyPi](https://pypi.org/project/geoapi-client/)\n\n```sh\npip install geoapi-client --user\n```\n\nThen import the package:\n```python\nimport geoapi_client \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\nimport geoapi_client\nfrom geoapi_client.rest import ApiException\nfrom pprint import pprint\n\nconfiguration = geoapi_client.Configuration()\nconfiguration.host = MY_HOST # e.g. https://agave.designsafe-ci.org/geo/v2\nconfiguration.api_key_prefix['Authorization'] = 'Bearer'\nconfiguration.api_key['Authorization'] = TOKEN\n\napi_client = geoapi_client.ApiClient(configuration)\napi_instance = geoapi_client.ProjectsApi(api_client=api_client)\n\ntry:\n project = api_instance.create_project(payload={\"name\": \"My project\"})\n pprint(project)\n features = api_instance.upload_file(project.id, 'image.jpg')\n pprint(features)\nexcept ApiException as e:\n print(\"Exception: %s\\n\" % e)\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*NotificationsApi* | **delete** | **DELETE** /notifications/progress | \n*NotificationsApi* | **delete_0** | **DELETE** /notifications/progress/{progressUUID} | \n*NotificationsApi* | **get** | **GET** /notifications/ | \n*NotificationsApi* | **get_0** | **GET** /notifications/progress | \n*NotificationsApi* | **get_1** | **GET** /notifications/progress/{progressUUID} | \n*ProjectsApi* | **add_feature_asset** | **POST** /projects/{projectId}/features/{featureId}/assets/ | \n*ProjectsApi* | **add_geo_json_feature** | **POST** /projects/{projectId}/features/ | \n*ProjectsApi* | **add_overlay** | **POST** /projects/{projectId}/overlays/ | \n*ProjectsApi* | **add_point_cloud** | **POST** /projects/{projectId}/point-cloud/ | \n*ProjectsApi* | **add_streetview_sequence_to_feature** | **POST** /projects/{projectId}/streetview/ | \n*ProjectsApi* | **add_tile_server** | **POST** /projects/{projectId}/tile-servers/ | \n*ProjectsApi* | **add_user** | **POST** /projects/{projectId}/users/ | \n*ProjectsApi* | **cluster_features** | **GET** /projects/{projectId}/features/cluster/{numClusters}/ | \n*ProjectsApi* | **create_project** | **POST** /projects/ | \n*ProjectsApi* | **delete_feature** | **DELETE** /projects/{projectId}/features/{featureId}/ | \n*ProjectsApi* | **delete_point_cloud** | **DELETE** /projects/{projectId}/point-cloud/{pointCloudId}/ | \n*ProjectsApi* | **delete_project** | **DELETE** /projects/{projectId}/ | \n*ProjectsApi* | **get_all_features** | **GET** /projects/{projectId}/features/ | \n*ProjectsApi* | **get_all_point_clouds** | **GET** /projects/{projectId}/point-cloud/ | \n*ProjectsApi* | **get_feature** | **GET** /projects/{projectId}/features/{featureId}/ | \n*ProjectsApi* | **get_overlays** | **GET** /projects/{projectId}/overlays/ | \n*ProjectsApi* | **get_point_cloud** | **GET** /projects/{projectId}/point-cloud/{pointCloudId}/ | \n*ProjectsApi* | **get_project_by_id** | **GET** /projects/{projectId}/ | \n*ProjectsApi* | **get_project_users_resource** | **GET** /projects/{projectId}/users/ | \n*ProjectsApi* | **get_projects** | **GET** /projects/ | \n*ProjectsApi* | **get_streetview_sequence_from_feature** | **GET** /projects/{projectId}/streetview/{featureId}/ | \n*ProjectsApi* | **get_tasks** | **GET** /projects/{projectId}/tasks/ | \n*ProjectsApi* | **get_tile_servers** | **GET** /projects/{projectId}/tile-servers/ | \n*ProjectsApi* | **import_file_from_tapis** | **POST** /projects/{projectId}/features/files/import/ | \n*ProjectsApi* | **import_overlay_from_tapis** | **POST** /projects/{projectId}/overlays/import/ | \n*ProjectsApi* | **import_point_cloud_file_from_tapis** | **POST** /projects/{projectId}/point-cloud/{pointCloudId}/import/ | \n*ProjectsApi* | **remove_overlay** | **DELETE** /projects/{projectId}/overlays/{overlayId}/ | \n*ProjectsApi* | **remove_tile_server** | **DELETE** /projects/{projectId}/tile-servers/{tileServerId}/ | \n*ProjectsApi* | **remove_user** | **DELETE** /projects/{projectId}/users/{username}/ | \n*ProjectsApi* | **update_feature_properties** | **POST** /projects/{projectId}/features/{featureId}/properties/ | \n*ProjectsApi* | **update_feature_styles** | **POST** /projects/{projectId}/features/{featureId}/styles/ | \n*ProjectsApi* | **update_point_c_loud** | **PUT** /projects/{projectId}/point-cloud/{pointCloudId}/ | \n*ProjectsApi* | **update_project** | **PUT** /projects/{projectId}/ | \n*ProjectsApi* | **update_tile_server** | **PUT** /projects/{projectId}/tile-servers/{tileServerId}/ | \n*ProjectsApi* | **update_tile_servers** | **PUT** /projects/{projectId}/tile-servers/ | \n*ProjectsApi* | **upload_file** | **POST** /projects/{projectId}/features/files/ | \n*ProjectsApi* | **upload_point_cloud** | **POST** /projects/{projectId}/point-cloud/{pointCloudId}/ | :raises InvalidCoordinateReferenceSystem: in case file missing coordinate reference system\n*PublicProjectsApi* | **get_all_features** | **GET** /public-projects/{projectId}/features/ | \n*PublicProjectsApi* | **get_all_point_clouds** | **GET** /public-projects/{projectId}/point-cloud/ | \n*PublicProjectsApi* | **get_feature** | **GET** /public-projects/{projectId}/features/{featureId}/ | \n*PublicProjectsApi* | **get_overlays** | **GET** /public-projects/{projectId}/overlays/ | \n*PublicProjectsApi* | **get_point_cloud** | **GET** /public-projects/{projectId}/point-cloud/{pointCloudId}/ | \n*PublicProjectsApi* | **get_project_by_id** | **GET** /public-projects/{projectId}/ | \n*PublicProjectsApi* | **get_projects** | **GET** /public-projects/ | \n*PublicProjectsApi* | **get_tile_servers** | **GET** /public-projects/{projectId}/tile-servers/ | \n*StreetviewApi* | **add_streetview_sequence** | **POST** /streetview/sequences/ | \n*StreetviewApi* | **create_streetview_organizations** | **POST** /streetview/services/{service}/organization/ | \n*StreetviewApi* | **create_streetview_service_resource** | **POST** /streetview/services/ | \n*StreetviewApi* | **delete_streetview_instance** | **DELETE** /streetview/instances/{instance_id}/ | \n*StreetviewApi* | **delete_streetview_organization** | **DELETE** /streetview/services/{service}/organization/{organization_id}/ | \n*StreetviewApi* | **delete_streetview_sequence** | **DELETE** /streetview/sequences/{sequence_id}/ | \n*StreetviewApi* | **delete_streetview_service_resource** | **DELETE** /streetview/services/{service}/ | \n*StreetviewApi* | **get_streetview_organizations** | **GET** /streetview/services/{service}/organization/ | \n*StreetviewApi* | **get_streetview_sequence** | **GET** /streetview/sequences/{sequence_id}/ | \n*StreetviewApi* | **get_streetview_service_resource** | **GET** /streetview/services/{service}/ | \n*StreetviewApi* | **get_streetview_service_resources** | **GET** /streetview/services/ | \n*StreetviewApi* | **publish_files_to_streetview** | **POST** /streetview/publish/ | \n*StreetviewApi* | **update_streetview_organization** | **PUT** /streetview/services/{service}/organization/{organization_id}/ | \n*StreetviewApi* | **update_streetview_sequence** | **PUT** /streetview/sequences/{sequence_id}/ | \n*StreetviewApi* | **update_streetview_service_resource** | **PUT** /streetview/services/{service}/ | \n\n\n## Models\n\n - Asset\n - Feature\n - FeatureCollection\n - NotificationResponse\n - OkResponse\n - Overlay\n - Payload\n - PointCloud\n - ProgressNotificationResponse\n - Project\n - Streetview\n - StreetviewInstance\n - StreetviewOrganization\n - StreetviewParams\n - StreetviewSequence\n - TapisFile\n - TapisFileImport\n - TapisFileUpload\n - TapisFolderImport\n - Task\n - TileServer\n - User\n - UserPayload\n\n\n## Documentation For Authorization\n\n\n## JWT\n\n- **Type**: API key\n- **API key parameter name**: X-JWT-Assertion-designsafe\n- **Location**: HTTP header\n\n## Token\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\nTexas Advanced Computing Center\nCICsupport@tacc.utexas.edu\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "GeoAPI: Geospatial API for TAPIS",
"version": "2.10",
"split_keywords": [
"tacc",
"geoapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4853945e22d68393a6e959cc82ae2f7a990333ffa949a8e749b1c677bd0d82e",
"md5": "82f79716b27ae92dcd98248a3f8c994f",
"sha256": "bd06a8e6926831e46813aeb1f21e00ded6a85d1c67478f9269b85418c95060fc"
},
"downloads": -1,
"filename": "geoapi_client-2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82f79716b27ae92dcd98248a3f8c994f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 84160,
"upload_time": "2023-01-18T04:22:53",
"upload_time_iso_8601": "2023-01-18T04:22:53.851894Z",
"url": "https://files.pythonhosted.org/packages/e4/85/3945e22d68393a6e959cc82ae2f7a990333ffa949a8e749b1c677bd0d82e/geoapi_client-2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ac433437877f59f149c2bbff4855e2c4f19e9a07a20792948450997e8046496",
"md5": "4123a4029f89bed358fefe6977918e6a",
"sha256": "439b0c597d6408a46b638b7dc5dc645d920bf4bf40e0a43557877984b5b1e9d0"
},
"downloads": -1,
"filename": "geoapi-client-2.10.tar.gz",
"has_sig": false,
"md5_digest": "4123a4029f89bed358fefe6977918e6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41737,
"upload_time": "2023-01-18T04:22:56",
"upload_time_iso_8601": "2023-01-18T04:22:56.304847Z",
"url": "https://files.pythonhosted.org/packages/3a/c4/33437877f59f149c2bbff4855e2c4f19e9a07a20792948450997e8046496/geoapi-client-2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-18 04:22:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "TACC-Cloud",
"github_project": "geoapi",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "geoapi-client"
}
JSON
