Metadata-Version: 2.4
Name: neurosynth_compose_sdk
Version: 1.1
Summary: Analysis Specification for Meta-analysis
Home-page: https://github.com/neurostuff/neurosynth-compose-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,Analysis Specification for Meta-analysis
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
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
Dynamic: license-file

# neurosynth-compose-sdk
api to create a meta-analysis specification

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

- API version: 1.1
- Package version: 1.1
- 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 neurosynth_compose_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 neurosynth_compose_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ComposeApi* | [**meta_analyses_get**](docs/ComposeApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses
*ComposeApi* | [**meta_analyses_id_get**](docs/ComposeApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information
*ComposeApi* | [**meta_analyses_id_put**](docs/ComposeApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis
*ComposeApi* | [**meta_analyses_post**](docs/ComposeApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis
*ComposeApi* | [**meta_analysis_jobs_get**](docs/ComposeApi.md#meta_analysis_jobs_get) | **GET** /meta-analysis-jobs | List meta-analysis jobs for the current user
*ComposeApi* | [**meta_analysis_jobs_job_id_get**](docs/ComposeApi.md#meta_analysis_jobs_job_id_get) | **GET** /meta-analysis-jobs/{job_id} | Get status and logs for a meta-analysis job
*ComposeApi* | [**meta_analysis_jobs_post**](docs/ComposeApi.md#meta_analysis_jobs_post) | **POST** /meta-analysis-jobs | Submit a meta-analysis job
*ComposeApi* | [**meta_analysis_results_get**](docs/ComposeApi.md#meta_analysis_results_get) | **GET** /meta-analysis-results | List meta-analysis results
*ComposeApi* | [**meta_analysis_results_id_get**](docs/ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Get a meta-analysis result by ID
*ComposeApi* | [**meta_analysis_results_id_put**](docs/ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | Update a meta-analysis result with files or snapshots
*ComposeApi* | [**meta_analysis_results_post**](docs/ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | Create a new meta-analysis result
*ComposeApi* | [**neurostore_annotations_id_get**](docs/ComposeApi.md#neurostore_annotations_id_get) | **GET** /neurostore-annotations/{id} | Get a Neurostore annotation reference by Neurostore ID
*ComposeApi* | [**neurostore_studies_get**](docs/ComposeApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint
*ComposeApi* | [**neurostore_studies_id_get**](docs/ComposeApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint
*ComposeApi* | [**neurostore_studysets_get**](docs/ComposeApi.md#neurostore_studysets_get) | **GET** /neurostore-studysets | List Neurostore studyset references
*ComposeApi* | [**neurostore_studysets_id_get**](docs/ComposeApi.md#neurostore_studysets_id_get) | **GET** /neurostore-studysets/{id} | Get a Neurostore studyset reference by Neurostore ID
*ComposeApi* | [**neurovault_collections_get**](docs/ComposeApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections
*ComposeApi* | [**neurovault_collections_id_get**](docs/ComposeApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint
*ComposeApi* | [**neurovault_collections_id_put**](docs/ComposeApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | 
*ComposeApi* | [**neurovault_collections_post**](docs/ComposeApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection
*ComposeApi* | [**neurovault_files_get**](docs/ComposeApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint
*ComposeApi* | [**neurovault_files_id_get**](docs/ComposeApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint
*ComposeApi* | [**neurovault_files_id_put**](docs/ComposeApi.md#neurovault_files_id_put) | **PUT** /neurovault-files/{id} | 
*ComposeApi* | [**neurovault_files_post**](docs/ComposeApi.md#neurovault_files_post) | **POST** /neurovault-files | 
*ComposeApi* | [**projects_get**](docs/ComposeApi.md#projects_get) | **GET** /projects | Your GET endpoint
*ComposeApi* | [**projects_id_delete**](docs/ComposeApi.md#projects_id_delete) | **DELETE** /projects/{id} | 
*ComposeApi* | [**projects_id_get**](docs/ComposeApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint
*ComposeApi* | [**projects_id_put**](docs/ComposeApi.md#projects_id_put) | **PUT** /projects/{id} | 
*ComposeApi* | [**projects_post**](docs/ComposeApi.md#projects_post) | **POST** /projects | 
*ComposeApi* | [**snapshot_annotations_get**](docs/ComposeApi.md#snapshot_annotations_get) | **GET** /snapshot-annotations | GET a list of annotations
*ComposeApi* | [**snapshot_annotations_id_get**](docs/ComposeApi.md#snapshot_annotations_id_get) | **GET** /snapshot-annotations/{id} | GET information about an annotation
*ComposeApi* | [**snapshot_annotations_id_put**](docs/ComposeApi.md#snapshot_annotations_id_put) | **PUT** /snapshot-annotations/{id} | Update an Annotation
*ComposeApi* | [**snapshot_annotations_post**](docs/ComposeApi.md#snapshot_annotations_post) | **POST** /snapshot-annotations | Create a new Annotation
*ComposeApi* | [**snapshot_studysets_get**](docs/ComposeApi.md#snapshot_studysets_get) | **GET** /snapshot-studysets | Get a list of Studysets
*ComposeApi* | [**snapshot_studysets_id_get**](docs/ComposeApi.md#snapshot_studysets_id_get) | **GET** /snapshot-studysets/{id} | Get information about a Studyset
*ComposeApi* | [**snapshot_studysets_id_put**](docs/ComposeApi.md#snapshot_studysets_id_put) | **PUT** /snapshot-studysets/{id} | Update a Studyset
*ComposeApi* | [**snapshot_studysets_post**](docs/ComposeApi.md#snapshot_studysets_post) | **POST** /snapshot-studysets | Create a new Studyset
*ComposeApi* | [**specifications_get**](docs/ComposeApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications
*ComposeApi* | [**specifications_id_get**](docs/ComposeApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification
*ComposeApi* | [**specifications_id_put**](docs/ComposeApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification
*ComposeApi* | [**specifications_post**](docs/ComposeApi.md#specifications_post) | **POST** /specifications | Create a Specification
*ComposeApi* | [**tags_get**](docs/ComposeApi.md#tags_get) | **GET** /tags | Get a list of Tags
*ComposeApi* | [**tags_id_get**](docs/ComposeApi.md#tags_id_get) | **GET** /tags/{id} | Get information about a Tag
*ComposeApi* | [**tags_post**](docs/ComposeApi.md#tags_post) | **POST** /tags | Create a new Tag
*ComposeApi* | [**users_get**](docs/ComposeApi.md#users_get) | **GET** /users | GET list of Users
*ComposeApi* | [**users_id_get**](docs/ComposeApi.md#users_id_get) | **GET** /users/{id} | Get User Info by User ID
*ComposeApi* | [**users_id_put**](docs/ComposeApi.md#users_id_put) | **PUT** /users/{id} | Update User Information
*ComposeApi* | [**users_post**](docs/ComposeApi.md#users_post) | **POST** /users | Create A New User
*DefaultApi* | [**meta_analyses_id_delete**](docs/DefaultApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | 
*DefaultApi* | [**neurostore_studies_id_put**](docs/DefaultApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | 
*DefaultApi* | [**neurostore_studies_post**](docs/DefaultApi.md#neurostore_studies_post) | **POST** /neurostore-studies | 


## Documentation For Models

 - [Annotation](docs/Annotation.md)
 - [AnnotationList](docs/AnnotationList.md)
 - [AnnotationPostBody](docs/AnnotationPostBody.md)
 - [AnnotationReference](docs/AnnotationReference.md)
 - [AnnotationReferenceReturn](docs/AnnotationReferenceReturn.md)
 - [AnnotationReturn](docs/AnnotationReturn.md)
 - [AnnotationSnapshotSummary](docs/AnnotationSnapshotSummary.md)
 - [AnnotationUpdate](docs/AnnotationUpdate.md)
 - [Corrector](docs/Corrector.md)
 - [Estimator](docs/Estimator.md)
 - [MetaAnalysesGet400Response](docs/MetaAnalysesGet400Response.md)
 - [MetaAnalysis](docs/MetaAnalysis.md)
 - [MetaAnalysisJobList](docs/MetaAnalysisJobList.md)
 - [MetaAnalysisJobListMetadata](docs/MetaAnalysisJobListMetadata.md)
 - [MetaAnalysisJobLog](docs/MetaAnalysisJobLog.md)
 - [MetaAnalysisJobRequest](docs/MetaAnalysisJobRequest.md)
 - [MetaAnalysisJobResponse](docs/MetaAnalysisJobResponse.md)
 - [MetaAnalysisList](docs/MetaAnalysisList.md)
 - [MetaAnalysisNeurostoreAnnotation](docs/MetaAnalysisNeurostoreAnnotation.md)
 - [MetaAnalysisNeurostoreStudyset](docs/MetaAnalysisNeurostoreStudyset.md)
 - [MetaAnalysisPostBody](docs/MetaAnalysisPostBody.md)
 - [MetaAnalysisResults](docs/MetaAnalysisResults.md)
 - [MetaAnalysisReturn](docs/MetaAnalysisReturn.md)
 - [MetaAnalysisSpecification](docs/MetaAnalysisSpecification.md)
 - [MetaAnalysisTags](docs/MetaAnalysisTags.md)
 - [NeurostoreAnalysis](docs/NeurostoreAnalysis.md)
 - [NeurostoreStudy](docs/NeurostoreStudy.md)
 - [NeurostoreStudyList](docs/NeurostoreStudyList.md)
 - [NeurostoreStudyReturn](docs/NeurostoreStudyReturn.md)
 - [NeurovaultCollection](docs/NeurovaultCollection.md)
 - [NeurovaultCollectionFilesInner](docs/NeurovaultCollectionFilesInner.md)
 - [NeurovaultCollectionReturn](docs/NeurovaultCollectionReturn.md)
 - [NeurovaultFile](docs/NeurovaultFile.md)
 - [NeurovaultFileList](docs/NeurovaultFileList.md)
 - [NeurovaultFileReturn](docs/NeurovaultFileReturn.md)
 - [NeurovaultList](docs/NeurovaultList.md)
 - [Project](docs/Project.md)
 - [ProjectList](docs/ProjectList.md)
 - [ProjectMetaAnalyses](docs/ProjectMetaAnalyses.md)
 - [ProjectReturn](docs/ProjectReturn.md)
 - [ReadOnly](docs/ReadOnly.md)
 - [Result](docs/Result.md)
 - [ResultInit](docs/ResultInit.md)
 - [ResultList](docs/ResultList.md)
 - [ResultListResults](docs/ResultListResults.md)
 - [ResultReturn](docs/ResultReturn.md)
 - [ResultUploadStatisticalMaps](docs/ResultUploadStatisticalMaps.md)
 - [Specification](docs/Specification.md)
 - [SpecificationConditions](docs/SpecificationConditions.md)
 - [SpecificationList](docs/SpecificationList.md)
 - [SpecificationPostBody](docs/SpecificationPostBody.md)
 - [SpecificationReturn](docs/SpecificationReturn.md)
 - [Studyset](docs/Studyset.md)
 - [StudysetList](docs/StudysetList.md)
 - [StudysetPostBody](docs/StudysetPostBody.md)
 - [StudysetReference](docs/StudysetReference.md)
 - [StudysetReferenceList](docs/StudysetReferenceList.md)
 - [StudysetReferenceReturn](docs/StudysetReferenceReturn.md)
 - [StudysetReturn](docs/StudysetReturn.md)
 - [StudysetSnapshotSummary](docs/StudysetSnapshotSummary.md)
 - [Tag](docs/Tag.md)
 - [TagList](docs/TagList.md)
 - [TagReturn](docs/TagReturn.md)
 - [User](docs/User.md)
 - [UserList](docs/UserList.md)
 - [UserReturn](docs/UserReturn.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

<a id="upload_key"></a>
### upload_key

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


## 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 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

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

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