Skip to content

Latest commit

 

History

History
162 lines (123 loc) · 6.45 KB

README.md

File metadata and controls

162 lines (123 loc) · 6.45 KB
Raw

neurostore-api

Create datasets for meta-analysis

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

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

Requirements.

Python >= 3.6

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_api

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_api

Getting Started

Please follow the installation procedure and then run the following:

import time
import neurostore_api
from pprint import pprint
from neurostore_api.api import analyses_api
from neurostore_api.model.analysis import Analysis
from neurostore_api.model.inline_response404 import InlineResponse404
from neurostore_api.model.inline_response422 import InlineResponse422
# Defining the host is optional and defaults to http://localhost:80/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_api.Configuration(
    host = "http://localhost:80/api"
)



# Enter a context with an instance of the API client
with neurostore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = analyses_api.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 = 0 # int | page of results (optional)
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
page_size = 1 # int | number of results to show on a page (optional)

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

Documentation for API Endpoints

All URIs are relative to http://localhost:80/api

Class Method HTTP request Description
AnalysesApi analyses_get GET /analyses/ GET list of analyses
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
ConditionsApi conditions_id_get GET /conditions/{id} GET a condition
ConditionsApi conditions_id_put PUT /conditions/{id} PUT/update a condition
DatasetsApi datasets_get GET /datasets/ GET a list of datasets
DatasetsApi datasets_id_get GET /datasets/{id} GET a dataset
DatasetsApi datasets_id_put PUT /datasets/{id} PUT/update a dataset
DatasetsApi datasets_post POST /datasets/ POST/create a dataset
ImagesApi images_get GET /images/ GET a list of images
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_id_get GET /points/{id} GET a point
PointsApi points_id_put PUT /points/{id} PUT/update a point
StudiesApi studies_get GET /studies/ GET a list of studies
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
UserApi login_post POST /login Login
UserApi register_post POST /register Register Account

Documentation For Models

Documentation For Authorization

JSON-Web-Token

  • Type: Bearer authentication

Author

[email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in neurostore_api.apis and neurostore_api.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 neurostore_api.api.default_api import DefaultApi
  • from neurostore_api.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import neurostore_api
from neurostore_api.apis import *
from neurostore_api.models import *