aind-dataverse-service-async-client 0.0.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aind_dataverse_service_async_client-0.0.2/PKG-INFO +25 -0
- aind_dataverse_service_async_client-0.0.2/README.md +117 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/__init__.py +39 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/api/__init__.py +6 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/api/default_api.py +547 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/api/healthcheck_api.py +281 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/api_client.py +800 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/api_response.py +21 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/configuration.py +568 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/exceptions.py +216 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/__init__.py +21 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/entity_table_row.py +113 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/health_check.py +99 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/http_validation_error.py +95 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/validation_error.py +99 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/models/validation_error_loc_inner.py +138 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/py.typed +0 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client/rest.py +213 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client.egg-info/PKG-INFO +25 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client.egg-info/SOURCES.txt +32 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client.egg-info/dependency_links.txt +1 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client.egg-info/requires.txt +6 -0
- aind_dataverse_service_async_client-0.0.2/aind_dataverse_service_async_client.egg-info/top_level.txt +1 -0
- aind_dataverse_service_async_client-0.0.2/pyproject.toml +91 -0
- aind_dataverse_service_async_client-0.0.2/setup.cfg +7 -0
- aind_dataverse_service_async_client-0.0.2/setup.py +51 -0
- aind_dataverse_service_async_client-0.0.2/test/test_default_api.py +45 -0
- aind_dataverse_service_async_client-0.0.2/test/test_entity_table_row.py +54 -0
- aind_dataverse_service_async_client-0.0.2/test/test_health_check.py +52 -0
- aind_dataverse_service_async_client-0.0.2/test/test_healthcheck_api.py +38 -0
- aind_dataverse_service_async_client-0.0.2/test/test_http_validation_error.py +58 -0
- aind_dataverse_service_async_client-0.0.2/test/test_validation_error.py +60 -0
- aind_dataverse_service_async_client-0.0.2/test/test_validation_error_loc_inner.py +50 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: aind-dataverse-service-async-client
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: aind-dataverse-service
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: team@openapitools.org
|
|
8
|
+
Keywords: OpenAPI,OpenAPI-Generator,aind-dataverse-service
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
11
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
12
|
+
Requires-Dist: aiohttp>=3.8.4
|
|
13
|
+
Requires-Dist: aiohttp-retry>=2.8.3
|
|
14
|
+
Requires-Dist: pydantic>=2
|
|
15
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
16
|
+
Dynamic: author
|
|
17
|
+
Dynamic: author-email
|
|
18
|
+
Dynamic: description
|
|
19
|
+
Dynamic: description-content-type
|
|
20
|
+
Dynamic: keywords
|
|
21
|
+
Dynamic: requires-dist
|
|
22
|
+
Dynamic: summary
|
|
23
|
+
|
|
24
|
+
## aind-dataverse-service Service to pull data from Allen Institute's Dataverse database.
|
|
25
|
+
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# aind-dataverse-service-async-client
|
|
2
|
+
|
|
3
|
+
## aind-dataverse-service
|
|
4
|
+
|
|
5
|
+
Service to pull data from Allen Institute's Dataverse database.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
10
|
+
|
|
11
|
+
- API version: 0.0.2
|
|
12
|
+
- Package version: 0.0.2
|
|
13
|
+
- Generator version: 7.13.0
|
|
14
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
15
|
+
|
|
16
|
+
## Requirements.
|
|
17
|
+
|
|
18
|
+
Python 3.9+
|
|
19
|
+
|
|
20
|
+
## Installation & Usage
|
|
21
|
+
### pip install
|
|
22
|
+
|
|
23
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
27
|
+
```
|
|
28
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
29
|
+
|
|
30
|
+
Then import the package:
|
|
31
|
+
```python
|
|
32
|
+
import aind_dataverse_service_async_client
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Setuptools
|
|
36
|
+
|
|
37
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
python setup.py install --user
|
|
41
|
+
```
|
|
42
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
43
|
+
|
|
44
|
+
Then import the package:
|
|
45
|
+
```python
|
|
46
|
+
import aind_dataverse_service_async_client
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tests
|
|
50
|
+
|
|
51
|
+
Execute `pytest` to run the tests.
|
|
52
|
+
|
|
53
|
+
## Getting Started
|
|
54
|
+
|
|
55
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
|
|
59
|
+
import aind_dataverse_service_async_client
|
|
60
|
+
from aind_dataverse_service_async_client.rest import ApiException
|
|
61
|
+
from pprint import pprint
|
|
62
|
+
|
|
63
|
+
# Defining the host is optional and defaults to http://localhost
|
|
64
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
65
|
+
configuration = aind_dataverse_service_async_client.Configuration(
|
|
66
|
+
host = "http://localhost"
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
# Enter a context with an instance of the API client
|
|
72
|
+
async with aind_dataverse_service_async_client.ApiClient(configuration) as api_client:
|
|
73
|
+
# Create an instance of the API class
|
|
74
|
+
api_instance = aind_dataverse_service_async_client.DefaultApi(api_client)
|
|
75
|
+
entity_set_table_name = 'cr138_projects' # str | The entity set name of the table to fetch
|
|
76
|
+
|
|
77
|
+
try:
|
|
78
|
+
# Get Table
|
|
79
|
+
api_response = await api_instance.get_table(entity_set_table_name)
|
|
80
|
+
print("The response of DefaultApi->get_table:\n")
|
|
81
|
+
pprint(api_response)
|
|
82
|
+
except ApiException as e:
|
|
83
|
+
print("Exception when calling DefaultApi->get_table: %s\n" % e)
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Documentation for API Endpoints
|
|
88
|
+
|
|
89
|
+
All URIs are relative to *http://localhost*
|
|
90
|
+
|
|
91
|
+
Class | Method | HTTP request | Description
|
|
92
|
+
------------ | ------------- | ------------- | -------------
|
|
93
|
+
*DefaultApi* | [**get_table**](docs/DefaultApi.md#get_table) | **GET** /tables/{entity_set_table_name} | Get Table
|
|
94
|
+
*DefaultApi* | [**get_table_info**](docs/DefaultApi.md#get_table_info) | **GET** /tables | Get Table Info
|
|
95
|
+
*HealthcheckApi* | [**get_health**](docs/HealthcheckApi.md#get_health) | **GET** /healthcheck | Perform a Health Check
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Documentation For Models
|
|
99
|
+
|
|
100
|
+
- [EntityTableRow](docs/EntityTableRow.md)
|
|
101
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
102
|
+
- [HealthCheck](docs/HealthCheck.md)
|
|
103
|
+
- [ValidationError](docs/ValidationError.md)
|
|
104
|
+
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<a id="documentation-for-authorization"></a>
|
|
108
|
+
## Documentation For Authorization
|
|
109
|
+
|
|
110
|
+
Endpoints do not require authorization.
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## Author
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
aind-dataverse-service
|
|
7
|
+
|
|
8
|
+
## aind-dataverse-service Service to pull data from Allen Institute's Dataverse database.
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 0.0.2
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "0.0.2"
|
|
18
|
+
|
|
19
|
+
# import apis into sdk package
|
|
20
|
+
from aind_dataverse_service_async_client.api.default_api import DefaultApi
|
|
21
|
+
from aind_dataverse_service_async_client.api.healthcheck_api import HealthcheckApi
|
|
22
|
+
|
|
23
|
+
# import ApiClient
|
|
24
|
+
from aind_dataverse_service_async_client.api_response import ApiResponse
|
|
25
|
+
from aind_dataverse_service_async_client.api_client import ApiClient
|
|
26
|
+
from aind_dataverse_service_async_client.configuration import Configuration
|
|
27
|
+
from aind_dataverse_service_async_client.exceptions import OpenApiException
|
|
28
|
+
from aind_dataverse_service_async_client.exceptions import ApiTypeError
|
|
29
|
+
from aind_dataverse_service_async_client.exceptions import ApiValueError
|
|
30
|
+
from aind_dataverse_service_async_client.exceptions import ApiKeyError
|
|
31
|
+
from aind_dataverse_service_async_client.exceptions import ApiAttributeError
|
|
32
|
+
from aind_dataverse_service_async_client.exceptions import ApiException
|
|
33
|
+
|
|
34
|
+
# import models into sdk package
|
|
35
|
+
from aind_dataverse_service_async_client.models.entity_table_row import EntityTableRow
|
|
36
|
+
from aind_dataverse_service_async_client.models.http_validation_error import HTTPValidationError
|
|
37
|
+
from aind_dataverse_service_async_client.models.health_check import HealthCheck
|
|
38
|
+
from aind_dataverse_service_async_client.models.validation_error import ValidationError
|
|
39
|
+
from aind_dataverse_service_async_client.models.validation_error_loc_inner import ValidationErrorLocInner
|