Skip to content

Latest commit

 

History

History
300 lines (260 loc) · 18.9 KB

README.md

File metadata and controls

300 lines (260 loc) · 18.9 KB
Raw

neurostore-sdk

Create studysets for meta-analysis

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

  • API version: 1.0
  • Package version: 0.0.1
  • Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen For more information, please visit https://github.com/jdkent

Requirements.

Python 3.7+

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 time
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.AnalysesApi(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)
    name = 'name_example' # str | search the name field for a term (optional)
    description = 'description_example' # str | search description 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, name=name, description=description, nested=nested)
        print("The response of AnalysesApi->analyses_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalysesApi->analyses_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AnalysesApi analyses_get GET /analyses/ GET list of analyses
AnalysesApi analyses_id_delete DELETE /analyses/{id} DELETE an analysis
AnalysesApi analyses_id_get GET /analyses/{id} GET an analysis
AnalysesApi analyses_id_put PUT /analyses/{id} PUT/update an analysis
AnalysesApi analyses_post POST /analyses/ POST/create an analysis
AnalysesApi annotation_analyses_get GET /annotation-analyses/ Get annotation analyses
AnalysesApi annotation_analyses_id_get GET /annotation-analyses/{id} Your GET endpoint
AnalysesApi annotation_analyses_id_put PUT /annotation-analyses/{id} Your PUT endpoint
AnalysesApi annotation_analyses_post POST /annotation-analyses/ Your POST endpoint
AnnotationsApi annotation_analyses_get GET /annotation-analyses/ Get annotation analyses
AnnotationsApi annotation_analyses_id_get GET /annotation-analyses/{id} Your GET endpoint
AnnotationsApi annotation_analyses_id_put PUT /annotation-analyses/{id} Your PUT endpoint
AnnotationsApi annotation_analyses_post POST /annotation-analyses/ Your POST endpoint
AnnotationsApi annotations_get GET /annotations/ Your GET endpoint
AnnotationsApi annotations_id_delete DELETE /annotations/{id} DELETE an annotation
AnnotationsApi annotations_id_get GET /annotations/{id} Your GET endpoint
AnnotationsApi annotations_id_put PUT /annotations/{id} Update an annotation
AnnotationsApi annotations_post POST /annotations/ Post Annotation
ConditionsApi conditions_get GET /conditions/ GET Conditions
ConditionsApi conditions_id_delete DELETE /conditions/{id} DELETE a condition
ConditionsApi conditions_id_get GET /conditions/{id} GET a condition
ConditionsApi conditions_id_put PUT /conditions/{id} PUT/update a condition
ConditionsApi conditions_post POST /conditions/ POST/Create a condition
ImagesApi images_get GET /images/ GET a list of images
ImagesApi images_id_delete DELETE /images/{id} DELETE an image
ImagesApi images_id_get GET /images/{id} GET an image
ImagesApi images_id_put PUT /images/{id} PUT/update an image
ImagesApi images_post POST /images/ POST/create an image
PointsApi points_get GET /points/ Get Points
PointsApi points_id_delete DELETE /points/{id} DELETE a point
PointsApi points_id_get GET /points/{id} GET a point
PointsApi points_id_put PUT /points/{id} PUT/update a point
PointsApi points_post POST /points/ POST Points
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 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_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
StudiesApi base_studies_get GET /base-studies/
StudiesApi base_studies_id_get GET /base-studies/{id} Your GET endpoint
StudiesApi base_studies_id_put PUT /base-studies/{id}
StudiesApi base_studies_post POST /base-studies/
StudiesApi studies_get GET /studies/ GET a list of studies
StudiesApi studies_id_delete DELETE /studies/{id} DELETE a study
StudiesApi studies_id_get GET /studies/{id} GET a study
StudiesApi studies_id_put PUT /studies/{id} PUT/update a study
StudiesApi studies_post POST /studies/ POST/create a study
StudysetsApi studysets_get GET /studysets/ GET a list of studysets
StudysetsApi studysets_id_delete DELETE /studysets/{id} DELETE a studyset
StudysetsApi studysets_id_get GET /studysets/{id} GET a studyset
StudysetsApi studysets_id_put PUT /studysets/{id} PUT/update a studyset
StudysetsApi studysets_post POST /studysets/ POST/create a studyset
UserApi users_get GET /users/ Your GET endpoint
UserApi users_id_get GET /users/{id} Individual User Profile
UserApi users_id_put PUT /users/{id} Update Individual Profile
UserApi users_post POST /users/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

JSON-Web-Token

  • Type: Bearer authentication

Author

[email protected]