neurostore-sdk 1.2

neurostore api

neurostore-sdk

Create studysets for meta-analysis

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.2
• Package version: 1.2
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/jdkent

Requirements.

Python 3.9+

Installation & Usage

pip install

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 neurostore_sdk

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 neurostore_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import neurostore_sdk
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)



# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.StoreApi(api_client)
    search = 'imagin' # str | search for entries that contain the substring (optional)
    sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
    page = 56 # int | page of results (optional)
    desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
    page_size = 56 # int | number of results to show on a page (optional)
    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
    study = 'study_example' # str | Filter tables by study id (optional)
    name = 'name_example' # str | search the name field for a term (optional)
    nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)

    try:
        # GET list of analyses
        api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, study=study, name=name, nested=nested)
        print("The response of StoreApi->analyses_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling StoreApi->analyses_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://neurostore.org/api

Class	Method	HTTP request	Description
StoreApi	analyses_get	GET /analyses/	GET list of analyses
StoreApi	analyses_id_delete	DELETE /analyses/{id}	DELETE an analysis
StoreApi	analyses_id_get	GET /analyses/{id}	GET an analysis
StoreApi	analyses_id_put	PUT /analyses/{id}	PUT/update an analysis
StoreApi	analyses_post	POST /analyses/	POST/create an analysis
StoreApi	annotation_analyses_get	GET /annotation-analyses/	Get annotation analyses
StoreApi	annotation_analyses_id_get	GET /annotation-analyses/{id}	Your GET endpoint
StoreApi	annotation_analyses_id_put	PUT /annotation-analyses/{id}	Your PUT endpoint
StoreApi	annotation_analyses_post	POST /annotation-analyses/	Your POST endpoint
StoreApi	annotations_get	GET /annotations/	Your GET endpoint
StoreApi	annotations_id_delete	DELETE /annotations/{id}	DELETE an annotation
StoreApi	annotations_id_get	GET /annotations/{id}	Your GET endpoint
StoreApi	annotations_id_put	PUT /annotations/{id}	Update an annotation
StoreApi	annotations_post	POST /annotations/	Post Annotation
StoreApi	base_studies_get	GET /base-studies/
StoreApi	base_studies_id_get	GET /base-studies/{id}	Your GET endpoint
StoreApi	base_studies_id_put	PUT /base-studies/{id}
StoreApi	base_studies_post	POST /base-studies/
StoreApi	conditions_get	GET /conditions/	GET Conditions
StoreApi	conditions_id_delete	DELETE /conditions/{id}	DELETE a condition
StoreApi	conditions_id_get	GET /conditions/{id}	GET a condition
StoreApi	conditions_id_put	PUT /conditions/{id}	PUT/update a condition
StoreApi	conditions_post	POST /conditions/	POST/Create a condition
StoreApi	images_get	GET /images/	GET a list of images
StoreApi	images_id_delete	DELETE /images/{id}	DELETE an image
StoreApi	images_id_get	GET /images/{id}	GET an image
StoreApi	images_id_put	PUT /images/{id}	PUT/update an image
StoreApi	images_post	POST /images/	POST/create an image
StoreApi	neurostore_studyset_releases_get	GET /neurostore-studyset-releases/	GET NeuroStore studyset release list
StoreApi	neurostore_studyset_releases_version_download_get	GET /neurostore-studyset-releases/{version}/download	Download NeuroStore studyset release tarball
StoreApi	neurostore_studyset_releases_version_get	GET /neurostore-studyset-releases/{version}	GET NeuroStore studyset release manifest
StoreApi	pipeline_configs_get	GET /pipeline-configs/	GET a list of pipeline configs
StoreApi	pipeline_configs_id_delete	DELETE /pipeline-configs/{id}	DELETE a pipeline config by ID
StoreApi	pipeline_configs_id_get	GET /pipeline-configs/{id}	GET a pipeline config by ID
StoreApi	pipeline_configs_id_put	PUT /pipeline-configs/{id}	PUT/update a pipeline config by ID
StoreApi	pipeline_configs_post	POST /pipeline-configs/	POST/create a pipeline config
StoreApi	pipeline_embeddings_get	GET /pipeline-embeddings/	List pipeline embeddings
StoreApi	pipeline_embeddings_id_get	GET /pipeline-embeddings/{id}	Get a pipeline embedding by id
StoreApi	pipeline_study_results_get	GET /pipeline-study-results/	GET a list of pipeline run results
StoreApi	pipeline_study_results_pipeline_study_result_id_delete	DELETE /pipeline-study-results/{pipeline_study_result_id}	DELETE a pipeline run result by ID
StoreApi	pipeline_study_results_pipeline_study_result_id_get	GET /pipeline-study-results/{pipeline_study_result_id}	GET a pipeline run result by ID
StoreApi	pipeline_study_results_pipeline_study_result_id_put	PUT /pipeline-study-results/{pipeline_study_result_id}	PUT/update a pipeline run result by ID
StoreApi	pipeline_study_results_post	POST /pipeline-study-results/	POST/create a pipeline run result
StoreApi	pipelines_get	GET /pipelines/	GET a list of pipelines
StoreApi	pipelines_id_delete	DELETE /pipelines/{id}	DELETE a pipeline by ID
StoreApi	pipelines_id_get	GET /pipelines/{id}	GET a pipeline by ID
StoreApi	pipelines_id_put	PUT /pipelines/{id}	PUT/update a pipeline by ID
StoreApi	pipelines_post	POST /pipelines/	POST/create a pipeline
StoreApi	points_get	GET /points/	Get Points
StoreApi	points_id_delete	DELETE /points/{id}	DELETE a point
StoreApi	points_id_get	GET /points/{id}	GET a point
StoreApi	points_id_put	PUT /points/{id}	PUT/update a point
StoreApi	points_post	POST /points/	POST Points
StoreApi	studies_get	GET /studies/	GET a list of studies
StoreApi	studies_id_delete	DELETE /studies/{id}	DELETE a study
StoreApi	studies_id_get	GET /studies/{id}	GET a study
StoreApi	studies_id_put	PUT /studies/{id}	PUT/update a study
StoreApi	studies_post	POST /studies/	POST/create a study
StoreApi	studysets_get	GET /studysets/	GET a list of studysets
StoreApi	studysets_id_delete	DELETE /studysets/{id}	DELETE a studyset
StoreApi	studysets_id_get	GET /studysets/{id}	GET a studyset
StoreApi	studysets_id_put	PUT /studysets/{id}	PUT/update a studyset
StoreApi	studysets_post	POST /studysets/	POST/create a studyset
StoreApi	tables_get	GET /tables/	GET list of tables
StoreApi	tables_id_delete	DELETE /tables/{id}	DELETE a table
StoreApi	tables_id_get	GET /tables/{id}	GET a table
StoreApi	tables_id_put	PUT /tables/{id}	PUT/update a table
StoreApi	tables_post	POST /tables/	POST/create a table
StoreApi	users_get	GET /users/	Your GET endpoint
StoreApi	users_id_get	GET /users/{id}	Individual User Profile
StoreApi	users_id_put	PUT /users/{id}	Update Individual Profile
StoreApi	users_post	POST /users/

Documentation For Models

• AnalysisBase
• AnalysisCommon
• AnalysisList
• AnalysisRequest
• AnalysisRequestRelationships
• AnalysisRequestRelationshipsConditions
• AnalysisRequestRelationshipsImages
• AnalysisRequestRelationshipsPoints
• AnalysisReturn
• AnalysisReturnRelationships
• AnalysisReturnRelationshipsConditions
• AnalysisReturnRelationshipsImages
• AnalysisReturnRelationshipsPoints
• AnnotationBase
• AnnotationCommon
• AnnotationExport
• AnnotationList
• AnnotationPipelineExtension
• AnnotationPipelineExtensionPipelinesInner
• AnnotationRequest
• AnnotationRequestOneOf
• AnnotationRequestRelationships
• AnnotationRequestRelationshipsNotes
• AnnotationReturn
• AnnotationReturnOneOf
• AnnotationReturnRelationships
• AnnotationReturnRelationshipsNotes
• BaseStudiesPost200Response
• BaseStudiesPostRequest
• BaseStudy
• BaseStudyList
• BaseStudyReturn
• BaseStudyVersionsInner
• Clone
• ConditionBase
• ConditionList
• ConditionRequest
• ConditionReturn
• Entity
• ErrorDetail
• ErrorResponse
• ImageBase
• ImageCommon
• ImageList
• ImageRelationships
• ImageRequest
• ImageReturn
• JsonLd
• JsonLdContext
• Metadata
• NestedPutAttributes
• NeurostoreStudysetReleasesGet200Response
• NeurostoreStudysetReleasesGet200ResponseMetadata
• NoteCollectionBase
• NoteCollectionList
• NoteCollectionRequest
• NoteCollectionReturn
• Pipeline
• PipelineConfig
• PipelineConfigList
• PipelineEmbedding
• PipelineEmbeddingList
• PipelineList
• PipelineStudyResult
• PipelineStudyResultList
• PipelineStudyResultPost
• PipelineStudyResultSearch
• PointBase
• PointCommon
• PointList
• PointRelationships
• PointRelationshipsValues
• PointRequest
• PointReturn
• PointValue
• ReadableResourceAttributes
• ResourceAttributes
• StudyBase
• StudyCommon
• StudyList
• StudyRequest
• StudyRequestRelationships
• StudyRequestRelationshipsAnalyses
• StudyReturn
• StudyReturnAllOfStudysets
• StudyReturnAllOfStudysetsOneOf
• StudyReturnRelationships
• StudyReturnRelationshipsAnalyses
• StudysetBase
• StudysetList
• StudysetRequest
• StudysetRequestRelationships
• StudysetRequestRelationshipsStudiesInner
• StudysetRequestRelationshipsStudiesInnerAnyOf
• StudysetReturn
• StudysetReturnRelationships
• StudysetReturnRelationshipsStudies
• StudysetReturnRelationshipsStudysetStudiesInner
• TableCommon
• TableList
• TableRequest
• TableRequestRelationships
• TableReturn
• TableReturnRelationships
• User
• UserList
• UserResourceAttributes
• UserlessResourceAttributes
• WriteableResourceAttributes

Documentation For Authorization

Authentication schemes defined for the API:

JSON-Web-Token

• Type: Bearer authentication

Author

[e-mail]

Neurostuff SDK Helpers

The generator adds two helper modules to reduce import friction:

1. sdk.py: a single facade for endpoint groups.
2. auth.py: Auth0 refresh-token exchange + automatic bearer token refresh.

Minimal usage

from neurostore_sdk.sdk import SDK

sdk = SDK(host="https://example.org/api", access_token="<access-token>")
studysets_api = sdk.studysets
result = studysets_api.studysets_get()

Auth0 refresh-token usage

from neurostore_sdk.sdk import SDK

sdk = SDK.from_auth0_refresh_token(
    domain="your-tenant.us.auth0.com",
    client_id="<auth0-client-id>",
    refresh_token="<auth0-refresh-token>",
    audience="<optional-audience>",
)

# Access token is exchanged and refreshed automatically per request.
users = sdk.users.users_get()

You can also use environment variables: AUTH0_DOMAIN, AUTH0_CLIENT_ID, AUTH0_REFRESH_TOKEN, plus optional AUTH0_AUDIENCE, AUTH0_CLIENT_SECRET, AUTH0_SCOPE.

sdk = SDK.from_auth0_env(prefix="AUTH0")