neurosynth-compose-sdk

api to create a meta-analysis specification

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 neurosynth_compose_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 neurosynth_compose_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import neurosynth_compose_sdk
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
    nested = True # bool | show nested component instead of id (optional)
    ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
    page = 56 # int | page of results (optional)
    page_size = 56 # int | number of elements to return on a page (optional)
    name = 'name_example' # str | search the name field for a term (optional)
    search = 'imagin' # str | search for entries that contain the substring (optional)
    description = 'description_example' # str | search description field for a term (optional)
    sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
    desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)

    try:
        # GET a list of meta-analyses
        api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
        print("The response of ComposeApi->meta_analyses_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComposeApi->meta_analyses_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://compose.neurosynth.org/api

Documentation For Models

• Annotation
• AnnotationList
• AnnotationPostBody
• AnnotationReference
• AnnotationReferenceReturn
• AnnotationReturn
• AnnotationSnapshotSummary
• AnnotationUpdate
• Corrector
• Estimator
• MetaAnalysesGet400Response
• MetaAnalysis
• MetaAnalysisJobList
• MetaAnalysisJobListMetadata
• MetaAnalysisJobLog
• MetaAnalysisJobRequest
• MetaAnalysisJobResponse
• MetaAnalysisList
• MetaAnalysisNeurostoreAnnotation
• MetaAnalysisNeurostoreStudyset
• MetaAnalysisPostBody
• MetaAnalysisResults
• MetaAnalysisReturn
• MetaAnalysisSpecification
• MetaAnalysisTags
• NeurostoreAnalysis
• NeurostoreStudy
• NeurostoreStudyList
• NeurostoreStudyReturn
• NeurovaultCollection
• NeurovaultCollectionFilesInner
• NeurovaultCollectionReturn
• NeurovaultFile
• NeurovaultFileList
• NeurovaultFileReturn
• NeurovaultList
• Project
• ProjectList
• ProjectMetaAnalyses
• ProjectReturn
• ReadOnly
• Result
• ResultInit
• ResultList
• ResultListResults
• ResultReturn
• ResultUploadStatisticalMaps
• Specification
• SpecificationConditions
• SpecificationList
• SpecificationPostBody
• SpecificationReturn
• Studyset
• StudysetList
• StudysetPostBody
• StudysetReference
• StudysetReferenceList
• StudysetReferenceReturn
• StudysetReturn
• StudysetSnapshotSummary
• Tag
• TagList
• TagReturn
• User
• UserList
• UserReturn

Documentation For Authorization

Authentication schemes defined for the API:

JSON-Web-Token

• Type: Bearer authentication

upload_key

• Type: API key
• API key parameter name: Compose-Upload-Key
• Location: HTTP header

Author

jamesdkent21@gmail.com

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 neurosynth_compose_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 neurosynth_compose_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")