All ur images r belong to us
This Python package is automatically generated by the OpenAPI Generator project:
Python >=3.7
Classes can have arbitrarily named properties set on them Endpoints can have arbitrary operationId method names set For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions on protected + public classes/methods. oapg stands for OpenApi Python Generator.
This was done because when payloads are ingested, they can be validated against N number of schemas. If the input signature used a different property name then that has mutated the payload. So SchemaA and SchemaB must both see the camelCase spec named variable. Also it is possible to send in two properties, named camelCase and camel_case in the same payload. That use case should be support so spec case is used.
Parameters can be included in different locations including:
Any of those parameters could use the same parameter names, so if every parameter was included as an endpoint parameter in a function signature, they would collide. For that reason, each of those inputs have been separated out into separate typed dictionaries:
So when updating your code, you will need to pass endpoint parameters in using those dictionaries.
Endpoint responses have been enriched to now include more information. Any response reom an endpoint will now include the following properties: response: urllib3.HTTPResponse body: typing.Union[Unset, Schema] headers: typing.Union[Unset, TODO] Note: response header deserialization has not yet been added
If the python package is hosted on a repository, you can install directly using:
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:
import neurovault_sdk
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 neurovault_sdk
Please follow the installation procedure and then run the following:
import time
import neurovault_sdk
from pprint import pprint
from neurovault_sdk.apis import atlases_api
from neurovault_sdk.model.atlas import Atlas
from neurovault_sdk.model.paginated_atlas_list import PaginatedAtlasList
from neurovault_sdk.model.patched_atlas import PatchedAtlas
# Defining the host is optional and defaults to https://neurovault.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurovault_sdk.Configuration(
host = "https://neurovault.org/api"
)
# Enter a context with an instance of the API client
with neurovault_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = atlases_api.AtlasesApi(api_client)
try:
api_response = api_instance.atlases_atlas_query_region_retrieve()
pprint(api_response)
except neurovault_sdk.ApiException as e:
print("Exception when calling AtlasesApi->atlases_atlas_query_region_retrieve: %s\n" % e)
All URIs are relative to https://neurovault.org/api
Class | Method | HTTP request | Description |
---|---|---|---|
AtlasesApi | atlases_atlas_query_region_retrieve | get /api/atlases/atlas_query_region/ | |
AtlasesApi | atlases_atlas_query_voxel_retrieve | get /api/atlases/atlas_query_voxel/ | |
AtlasesApi | atlases_datatable_retrieve | get /api/atlases/{id}/datatable/ | |
AtlasesApi | atlases_destroy | delete /api/atlases/{id}/ | |
AtlasesApi | atlases_list | get /api/atlases/ | |
AtlasesApi | atlases_partial_update | patch /api/atlases/{id}/ | |
AtlasesApi | atlases_regions_table_retrieve | get /api/atlases/{id}/regions_table/ | |
AtlasesApi | atlases_retrieve | get /api/atlases/{id}/ | |
AtlasesApi | atlases_update | put /api/atlases/{id}/ | |
CollectionsApi | collections_atlases_create | post /api/collections/{id}/atlases/ | |
CollectionsApi | collections_atlases_retrieve | get /api/collections/{id}/atlases/ | |
CollectionsApi | collections_create | post /api/collections/ | |
CollectionsApi | collections_datatable_retrieve | get /api/collections/{id}/datatable/ | |
CollectionsApi | collections_destroy | delete /api/collections/{id}/ | |
CollectionsApi | collections_images_create | post /api/collections/{id}/images/ | |
CollectionsApi | collections_images_retrieve | get /api/collections/{id}/images/ | |
CollectionsApi | collections_list | get /api/collections/ | |
CollectionsApi | collections_nidm_results_create | post /api/collections/{id}/nidm_results/ | |
CollectionsApi | collections_nidm_results_retrieve | get /api/collections/{id}/nidm_results/ | |
CollectionsApi | collections_partial_update | patch /api/collections/{id}/ | |
CollectionsApi | collections_retrieve | get /api/collections/{id}/ | |
CollectionsApi | collections_update | put /api/collections/{id}/ | |
ImagesApi | images_datatable_retrieve | get /api/images/{id}/datatable/ | |
ImagesApi | images_destroy | delete /api/images/{id}/ | |
ImagesApi | images_list | get /api/images/ | |
ImagesApi | images_partial_update | patch /api/images/{id}/ | |
ImagesApi | images_retrieve | get /api/images/{id}/ | |
ImagesApi | images_update | put /api/images/{id}/ | |
MyCollectionsApi | my_collections_atlases_create | post /api/my_collections/{id}/atlases/ | |
MyCollectionsApi | my_collections_atlases_retrieve | get /api/my_collections/{id}/atlases/ | |
MyCollectionsApi | my_collections_create | post /api/my_collections/ | |
MyCollectionsApi | my_collections_datatable_retrieve | get /api/my_collections/{id}/datatable/ | |
MyCollectionsApi | my_collections_destroy | delete /api/my_collections/{id}/ | |
MyCollectionsApi | my_collections_images_create | post /api/my_collections/{id}/images/ | |
MyCollectionsApi | my_collections_images_retrieve | get /api/my_collections/{id}/images/ | |
MyCollectionsApi | my_collections_list | get /api/my_collections/ | |
MyCollectionsApi | my_collections_nidm_results_create | post /api/my_collections/{id}/nidm_results/ | |
MyCollectionsApi | my_collections_nidm_results_retrieve | get /api/my_collections/{id}/nidm_results/ | |
MyCollectionsApi | my_collections_partial_update | patch /api/my_collections/{id}/ | |
MyCollectionsApi | my_collections_retrieve | get /api/my_collections/{id}/ | |
MyCollectionsApi | my_collections_update | put /api/my_collections/{id}/ | |
NidmResultsApi | nidm_results_destroy | delete /api/nidm_results/{id}/ | |
NidmResultsApi | nidm_results_list | get /api/nidm_results/ | |
NidmResultsApi | nidm_results_partial_update | patch /api/nidm_results/{id}/ | |
NidmResultsApi | nidm_results_retrieve | get /api/nidm_results/{id}/ | |
NidmResultsApi | nidm_results_update | put /api/nidm_results/{id}/ | |
UserApi | user_retrieve | get /api/user/ |
Authentication schemes defined for the API:
If the OpenAPI document is large, imports in neurovault_sdk.apis and neurovault_sdk.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from neurovault_sdk.apis.default_api import DefaultApi
from neurovault_sdk.model.pet import Pet
Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import neurovault_sdk
from neurovault_sdk.apis import *
from neurovault_sdk.models import *