Metadata-Version: 2.4
Name: neurostore_sdk
Version: 1.0
Summary: neurostore api
Home-page: https://github.com/neurostuff/neurostore-python-sdk
Author: James D Kent
Author-email: James D Kent <jamesdkent21@gmail.com>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,neurostore api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: lazy-imports<2,>=1
Dynamic: author
Dynamic: home-page

# neurostore-sdk
Create studysets for meta-analysis

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/jdkent](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:

```sh
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:
```python
import neurostore_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import neurostore_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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**](docs/StoreApi.md#analyses_get) | **GET** /analyses/ | GET list of analyses
*StoreApi* | [**analyses_id_delete**](docs/StoreApi.md#analyses_id_delete) | **DELETE** /analyses/{id} | DELETE an analysis
*StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
*StoreApi* | [**analyses_id_put**](docs/StoreApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
*StoreApi* | [**analyses_post**](docs/StoreApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
*StoreApi* | [**annotation_analyses_get**](docs/StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
*StoreApi* | [**annotation_analyses_id_get**](docs/StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
*StoreApi* | [**annotation_analyses_id_put**](docs/StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
*StoreApi* | [**annotation_analyses_post**](docs/StoreApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
*StoreApi* | [**annotations_get**](docs/StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
*StoreApi* | [**annotations_id_delete**](docs/StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
*StoreApi* | [**annotations_id_get**](docs/StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
*StoreApi* | [**annotations_id_put**](docs/StoreApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an annotation
*StoreApi* | [**annotations_post**](docs/StoreApi.md#annotations_post) | **POST** /annotations/ | Post Annotation
*StoreApi* | [**base_studies_get**](docs/StoreApi.md#base_studies_get) | **GET** /base-studies/ | 
*StoreApi* | [**base_studies_id_get**](docs/StoreApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
*StoreApi* | [**base_studies_id_put**](docs/StoreApi.md#base_studies_id_put) | **PUT** /base-studies/{id} | 
*StoreApi* | [**base_studies_post**](docs/StoreApi.md#base_studies_post) | **POST** /base-studies/ | 
*StoreApi* | [**conditions_get**](docs/StoreApi.md#conditions_get) | **GET** /conditions/ | GET Conditions
*StoreApi* | [**conditions_id_delete**](docs/StoreApi.md#conditions_id_delete) | **DELETE** /conditions/{id} | DELETE a condition
*StoreApi* | [**conditions_id_get**](docs/StoreApi.md#conditions_id_get) | **GET** /conditions/{id} | GET a condition
*StoreApi* | [**conditions_id_put**](docs/StoreApi.md#conditions_id_put) | **PUT** /conditions/{id} | PUT/update a condition
*StoreApi* | [**conditions_post**](docs/StoreApi.md#conditions_post) | **POST** /conditions/ | POST/Create a condition
*StoreApi* | [**images_get**](docs/StoreApi.md#images_get) | **GET** /images/ | GET a list of images
*StoreApi* | [**images_id_delete**](docs/StoreApi.md#images_id_delete) | **DELETE** /images/{id} | DELETE an image
*StoreApi* | [**images_id_get**](docs/StoreApi.md#images_id_get) | **GET** /images/{id} | GET an image
*StoreApi* | [**images_id_put**](docs/StoreApi.md#images_id_put) | **PUT** /images/{id} | PUT/update an image
*StoreApi* | [**images_post**](docs/StoreApi.md#images_post) | **POST** /images/ | POST/create an image
*StoreApi* | [**pipeline_configs_get**](docs/StoreApi.md#pipeline_configs_get) | **GET** /pipeline-configs/ | GET a list of pipeline configs
*StoreApi* | [**pipeline_configs_id_delete**](docs/StoreApi.md#pipeline_configs_id_delete) | **DELETE** /pipeline-configs/{id} | DELETE a pipeline config by ID
*StoreApi* | [**pipeline_configs_id_get**](docs/StoreApi.md#pipeline_configs_id_get) | **GET** /pipeline-configs/{id} | GET a pipeline config by ID
*StoreApi* | [**pipeline_configs_id_put**](docs/StoreApi.md#pipeline_configs_id_put) | **PUT** /pipeline-configs/{id} | PUT/update a pipeline config by ID
*StoreApi* | [**pipeline_configs_post**](docs/StoreApi.md#pipeline_configs_post) | **POST** /pipeline-configs/ | POST/create a pipeline config
*StoreApi* | [**pipeline_embeddings_get**](docs/StoreApi.md#pipeline_embeddings_get) | **GET** /pipeline-embeddings/ | List pipeline embeddings
*StoreApi* | [**pipeline_embeddings_id_get**](docs/StoreApi.md#pipeline_embeddings_id_get) | **GET** /pipeline-embeddings/{id} | Get a pipeline embedding by id
*StoreApi* | [**pipeline_study_results_get**](docs/StoreApi.md#pipeline_study_results_get) | **GET** /pipeline-study-results/ | GET a list of pipeline run results
*StoreApi* | [**pipeline_study_results_pipeline_study_result_id_delete**](docs/StoreApi.md#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**](docs/StoreApi.md#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**](docs/StoreApi.md#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**](docs/StoreApi.md#pipeline_study_results_post) | **POST** /pipeline-study-results/ | POST/create a pipeline run result
*StoreApi* | [**pipelines_get**](docs/StoreApi.md#pipelines_get) | **GET** /pipelines/ | GET a list of pipelines
*StoreApi* | [**pipelines_id_delete**](docs/StoreApi.md#pipelines_id_delete) | **DELETE** /pipelines/{id} | DELETE a pipeline by ID
*StoreApi* | [**pipelines_id_get**](docs/StoreApi.md#pipelines_id_get) | **GET** /pipelines/{id} | GET a pipeline by ID
*StoreApi* | [**pipelines_id_put**](docs/StoreApi.md#pipelines_id_put) | **PUT** /pipelines/{id} | PUT/update a pipeline by ID
*StoreApi* | [**pipelines_post**](docs/StoreApi.md#pipelines_post) | **POST** /pipelines/ | POST/create a pipeline
*StoreApi* | [**points_get**](docs/StoreApi.md#points_get) | **GET** /points/ | Get Points
*StoreApi* | [**points_id_delete**](docs/StoreApi.md#points_id_delete) | **DELETE** /points/{id} | DELETE a point
*StoreApi* | [**points_id_get**](docs/StoreApi.md#points_id_get) | **GET** /points/{id} | GET a point
*StoreApi* | [**points_id_put**](docs/StoreApi.md#points_id_put) | **PUT** /points/{id} | PUT/update a point
*StoreApi* | [**points_post**](docs/StoreApi.md#points_post) | **POST** /points/ | POST Points
*StoreApi* | [**studies_get**](docs/StoreApi.md#studies_get) | **GET** /studies/ | GET a list of studies
*StoreApi* | [**studies_id_delete**](docs/StoreApi.md#studies_id_delete) | **DELETE** /studies/{id} | DELETE a study
*StoreApi* | [**studies_id_get**](docs/StoreApi.md#studies_id_get) | **GET** /studies/{id} | GET a study
*StoreApi* | [**studies_id_put**](docs/StoreApi.md#studies_id_put) | **PUT** /studies/{id} | PUT/update a study
*StoreApi* | [**studies_post**](docs/StoreApi.md#studies_post) | **POST** /studies/ | POST/create a study
*StoreApi* | [**studysets_get**](docs/StoreApi.md#studysets_get) | **GET** /studysets/ | GET a list of studysets
*StoreApi* | [**studysets_id_delete**](docs/StoreApi.md#studysets_id_delete) | **DELETE** /studysets/{id} | DELETE a studyset
*StoreApi* | [**studysets_id_get**](docs/StoreApi.md#studysets_id_get) | **GET** /studysets/{id} | GET a studyset
*StoreApi* | [**studysets_id_put**](docs/StoreApi.md#studysets_id_put) | **PUT** /studysets/{id} | PUT/update a studyset
*StoreApi* | [**studysets_post**](docs/StoreApi.md#studysets_post) | **POST** /studysets/ | POST/create a studyset
*StoreApi* | [**tables_get**](docs/StoreApi.md#tables_get) | **GET** /tables/ | GET list of tables
*StoreApi* | [**tables_id_delete**](docs/StoreApi.md#tables_id_delete) | **DELETE** /tables/{id} | DELETE a table
*StoreApi* | [**tables_id_get**](docs/StoreApi.md#tables_id_get) | **GET** /tables/{id} | GET a table
*StoreApi* | [**tables_id_put**](docs/StoreApi.md#tables_id_put) | **PUT** /tables/{id} | PUT/update a table
*StoreApi* | [**tables_post**](docs/StoreApi.md#tables_post) | **POST** /tables/ | POST/create a table
*StoreApi* | [**users_get**](docs/StoreApi.md#users_get) | **GET** /users/ | Your GET endpoint
*StoreApi* | [**users_id_get**](docs/StoreApi.md#users_id_get) | **GET** /users/{id} | Individual User Profile
*StoreApi* | [**users_id_put**](docs/StoreApi.md#users_id_put) | **PUT** /users/{id} | Update Individual Profile
*StoreApi* | [**users_post**](docs/StoreApi.md#users_post) | **POST** /users/ | 


## Documentation For Models

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


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="JSON-Web-Token"></a>
### JSON-Web-Token

- **Type**: Bearer authentication


## Author

jamesdkent21@gmail.com



<!-- neurostuff-sdk-helpers:start -->
## 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

```python
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

```python
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`.

```python
sdk = SDK.from_auth0_env(prefix="AUTH0")
```
<!-- neurostuff-sdk-helpers:end -->
