3dd6e96afcb09f2f420268a596f268bedda7c543

neurostuff · Feb 25, 2025 · 2443275 · 2443275
1 parent 6af4493
commit 2443275
Show file tree

Hide file tree

Showing 147 changed files with 23,085 additions and 15,278 deletions.
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -13,25 +13,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install flake8 pytest
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          pip install -r requirements.txt
+          pip install -r test-requirements.txt
       - name: Test with pytest
         run: |
-          pytest
+          pytest --cov={{packageName}}
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -14,12 +14,18 @@ stages:
    - pip install -r test-requirements.txt
    - pytest --cov=neurosynth_compose_sdk
 
-pytest-3.7:
-  extends: .pytest
-  image: python:3.7-alpine
 pytest-3.8:
   extends: .pytest
   image: python:3.8-alpine
 pytest-3.9:
   extends: .pytest
-  image: python:3.9-alpine
+  image: python:3.9-alpine
+pytest-3.10:
+  extends: .pytest
+  image: python:3.10-alpine
+pytest-3.11:
+  extends: .pytest
+  image: python:3.11-alpine
+pytest-3.12:
+  extends: .pytest
+  image: python:3.12-alpine
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -8,7 +8,6 @@ docs/AnnotationList.md
 docs/AnnotationPostBody.md
 docs/AnnotationReturn.md
 docs/AnnotationUpdate.md
-docs/AnnotationUpdateAllOf.md
 docs/AnnotationsApi.md
 docs/ComposeApi.md
 docs/Corrector.md
@@ -29,7 +28,6 @@ docs/NeurostoreAnalysis.md
 docs/NeurostoreStudy.md
 docs/NeurostoreStudyList.md
 docs/NeurostoreStudyReturn.md
-docs/NeurovaultApi.md
 docs/NeurovaultCollection.md
 docs/NeurovaultCollectionFiles.md
 docs/NeurovaultCollectionReturn.md
@@ -77,7 +75,6 @@ neurosynth_compose_sdk/api/compose_api.py
 neurosynth_compose_sdk/api/default_api.py
 neurosynth_compose_sdk/api/get_api.py
 neurosynth_compose_sdk/api/meta_analyses_api.py
-neurosynth_compose_sdk/api/neurovault_api.py
 neurosynth_compose_sdk/api/post_api.py
 neurosynth_compose_sdk/api/projects_api.py
 neurosynth_compose_sdk/api/put_api.py
@@ -94,7 +91,6 @@ neurosynth_compose_sdk/models/annotation_list.py
 neurosynth_compose_sdk/models/annotation_post_body.py
 neurosynth_compose_sdk/models/annotation_return.py
 neurosynth_compose_sdk/models/annotation_update.py
-neurosynth_compose_sdk/models/annotation_update_all_of.py
 neurosynth_compose_sdk/models/corrector.py
 neurosynth_compose_sdk/models/estimator.py
 neurosynth_compose_sdk/models/meta_analyses_get400_response.py
@@ -143,6 +139,7 @@ neurosynth_compose_sdk/models/studyset_return.py
 neurosynth_compose_sdk/models/user.py
 neurosynth_compose_sdk/models/user_list.py
 neurosynth_compose_sdk/models/user_return.py
+neurosynth_compose_sdk/py.typed
 neurosynth_compose_sdk/rest.py
 pyproject.toml
 requirements.txt

diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-6.6.0
+7.11.0
diff --git a/.travis.yml b/.travis.yml
@@ -1,13 +1,13 @@
 # ref: https://docs.travis-ci.com/user/languages/python
 language: python
 python:
-  - "3.7"
   - "3.8"
   - "3.9"
   - "3.10"
   - "3.11"
+  - "3.12"
   # uncomment the following if needed
-  #- "3.11-dev"  # 3.11 development branch
+  #- "3.12-dev"  # 3.12 development branch
   #- "nightly"  # nightly build
 # command to install dependencies
 install:

diff --git a/README.md b/README.md
@@ -5,12 +5,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 
 - API version: 1.0
 - Package version: 0.0.1
-- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://github.com/jdkent](https://github.com/jdkent)
 
 ## Requirements.
 
-Python 3.7+
+Python 3.8+
 
 ## Installation & Usage
 ### pip install
@@ -51,7 +52,6 @@ Please follow the [installation procedure](#installation--usage) and then run th
 
 ```python
 
-import time
 import neurosynth_compose_sdk
 from neurosynth_compose_sdk.rest import ApiException
 from pprint import pprint
@@ -101,14 +101,6 @@ Class | Method | HTTP request | Description
 *ComposeApi* | [**meta_analysis_results_id_get**](docs/ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
 *ComposeApi* | [**meta_analysis_results_id_put**](docs/ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | 
 *ComposeApi* | [**meta_analysis_results_post**](docs/ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | 
-*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
@@ -123,10 +115,6 @@ Class | Method | HTTP request | Description
 *ComposeApi* | [**studysets_id_put**](docs/ComposeApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset
 *ComposeApi* | [**studysets_post**](docs/ComposeApi.md#studysets_post) | **POST** /studysets | Create a new Studyset
 *DefaultApi* | [**meta_analyses_id_delete**](docs/DefaultApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | 
-*DefaultApi* | [**neurostore_studies_get**](docs/DefaultApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint
-*DefaultApi* | [**neurostore_studies_id_get**](docs/DefaultApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint
-*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 | 
 *DefaultApi* | [**studyset_references_get**](docs/DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint
 *DefaultApi* | [**studyset_references_id_get**](docs/DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint
 *GetApi* | [**annotations_get**](docs/GetApi.md#annotations_get) | **GET** /annotations | GET a list of annotations
@@ -135,10 +123,6 @@ Class | Method | HTTP request | Description
 *GetApi* | [**meta_analyses_id_get**](docs/GetApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information
 *GetApi* | [**meta_analysis_results_get**](docs/GetApi.md#meta_analysis_results_get) | **GET** /meta-analysis-results | Your GET endpoint
 *GetApi* | [**meta_analysis_results_id_get**](docs/GetApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
-*GetApi* | [**neurovault_collections_get**](docs/GetApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections
-*GetApi* | [**neurovault_collections_id_get**](docs/GetApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint
-*GetApi* | [**neurovault_files_get**](docs/GetApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint
-*GetApi* | [**neurovault_files_id_get**](docs/GetApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint
 *GetApi* | [**projects_get**](docs/GetApi.md#projects_get) | **GET** /projects | Your GET endpoint
 *GetApi* | [**projects_id_get**](docs/GetApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint
 *GetApi* | [**specifications_get**](docs/GetApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications
@@ -153,19 +137,9 @@ Class | Method | HTTP request | Description
 *MetaAnalysesApi* | [**meta_analysis_results_id_get**](docs/MetaAnalysesApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
 *MetaAnalysesApi* | [**meta_analysis_results_id_put**](docs/MetaAnalysesApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | 
 *MetaAnalysesApi* | [**meta_analysis_results_post**](docs/MetaAnalysesApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | 
-*NeurovaultApi* | [**neurovault_collections_get**](docs/NeurovaultApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections
-*NeurovaultApi* | [**neurovault_collections_id_get**](docs/NeurovaultApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint
-*NeurovaultApi* | [**neurovault_collections_id_put**](docs/NeurovaultApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | 
-*NeurovaultApi* | [**neurovault_collections_post**](docs/NeurovaultApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection
-*NeurovaultApi* | [**neurovault_files_get**](docs/NeurovaultApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint
-*NeurovaultApi* | [**neurovault_files_id_get**](docs/NeurovaultApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint
-*NeurovaultApi* | [**neurovault_files_id_put**](docs/NeurovaultApi.md#neurovault_files_id_put) | **PUT** /neurovault-files/{id} | 
-*NeurovaultApi* | [**neurovault_files_post**](docs/NeurovaultApi.md#neurovault_files_post) | **POST** /neurovault-files | 
 *PostApi* | [**annotations_post**](docs/PostApi.md#annotations_post) | **POST** /annotations | Create a new Annotation
 *PostApi* | [**meta_analyses_post**](docs/PostApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis
 *PostApi* | [**meta_analysis_results_post**](docs/PostApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | 
-*PostApi* | [**neurovault_collections_post**](docs/PostApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection
-*PostApi* | [**neurovault_files_post**](docs/PostApi.md#neurovault_files_post) | **POST** /neurovault-files | 
 *PostApi* | [**projects_post**](docs/PostApi.md#projects_post) | **POST** /projects | 
 *PostApi* | [**specifications_post**](docs/PostApi.md#specifications_post) | **POST** /specifications | Create a Specification
 *PostApi* | [**studysets_post**](docs/PostApi.md#studysets_post) | **POST** /studysets | Create a new Studyset
@@ -177,8 +151,6 @@ Class | Method | HTTP request | Description
 *PutApi* | [**annotations_id_put**](docs/PutApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation
 *PutApi* | [**meta_analyses_id_put**](docs/PutApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis
 *PutApi* | [**meta_analysis_results_id_put**](docs/PutApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | 
-*PutApi* | [**neurovault_collections_id_put**](docs/PutApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | 
-*PutApi* | [**neurovault_files_id_put**](docs/PutApi.md#neurovault_files_id_put) | **PUT** /neurovault-files/{id} | 
 *PutApi* | [**projects_id_put**](docs/PutApi.md#projects_id_put) | **PUT** /projects/{id} | 
 *PutApi* | [**specifications_id_put**](docs/PutApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification
 *PutApi* | [**studysets_id_put**](docs/PutApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset
@@ -203,7 +175,6 @@ Class | Method | HTTP request | Description
  - [AnnotationPostBody](docs/AnnotationPostBody.md)
  - [AnnotationReturn](docs/AnnotationReturn.md)
  - [AnnotationUpdate](docs/AnnotationUpdate.md)
- - [AnnotationUpdateAllOf](docs/AnnotationUpdateAllOf.md)
  - [Corrector](docs/Corrector.md)
  - [Estimator](docs/Estimator.md)
  - [MetaAnalysesGet400Response](docs/MetaAnalysesGet400Response.md)

diff --git a/docs/Annotation.md b/docs/Annotation.md
@@ -3,6 +3,7 @@
 a holder/reference to the annotation on neurostore
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **neurostore_id** | **str** | the id of the annotation on neurostore | [optional] 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of Annotation from a JSON string
 annotation_instance = Annotation.from_json(json)
 # print the JSON string representation of the object
-print Annotation.to_json()
+print(Annotation.to_json())
 
 # convert the object into a dict
 annotation_dict = annotation_instance.to_dict()
 # create an instance of Annotation from a dict
-annotation_form_dict = annotation.from_dict(annotation_dict)
+annotation_from_dict = Annotation.from_dict(annotation_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnnotationList.md b/docs/AnnotationList.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **results** | [**List[AnnotationReturn]**](AnnotationReturn.md) |  | [optional] 
@@ -17,12 +18,12 @@ json = "{}"
 # create an instance of AnnotationList from a JSON string
 annotation_list_instance = AnnotationList.from_json(json)
 # print the JSON string representation of the object
-print AnnotationList.to_json()
+print(AnnotationList.to_json())
 
 # convert the object into a dict
 annotation_list_dict = annotation_list_instance.to_dict()
 # create an instance of AnnotationList from a dict
-annotation_list_form_dict = annotation_list.from_dict(annotation_list_dict)
+annotation_list_from_dict = AnnotationList.from_dict(annotation_list_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnnotationPostBody.md b/docs/AnnotationPostBody.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cached_studyset_id** | **str** |  | 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of AnnotationPostBody from a JSON string
 annotation_post_body_instance = AnnotationPostBody.from_json(json)
 # print the JSON string representation of the object
-print AnnotationPostBody.to_json()
+print(AnnotationPostBody.to_json())
 
 # convert the object into a dict
 annotation_post_body_dict = annotation_post_body_instance.to_dict()
 # create an instance of AnnotationPostBody from a dict
-annotation_post_body_form_dict = annotation_post_body.from_dict(annotation_post_body_dict)
+annotation_post_body_from_dict = AnnotationPostBody.from_dict(annotation_post_body_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnnotationReturn.md b/docs/AnnotationReturn.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **neurostore_id** | **str** | the id of the annotation on neurostore | [optional] 
@@ -24,12 +25,12 @@ json = "{}"
 # create an instance of AnnotationReturn from a JSON string
 annotation_return_instance = AnnotationReturn.from_json(json)
 # print the JSON string representation of the object
-print AnnotationReturn.to_json()
+print(AnnotationReturn.to_json())
 
 # convert the object into a dict
 annotation_return_dict = annotation_return_instance.to_dict()
 # create an instance of AnnotationReturn from a dict
-annotation_return_form_dict = annotation_return.from_dict(annotation_return_dict)
+annotation_return_from_dict = AnnotationReturn.from_dict(annotation_return_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnnotationUpdate.md b/docs/AnnotationUpdate.md
@@ -2,13 +2,14 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cached_studyset_id** | **str** |  | [optional] 
 **neurostore_id** | **str** | the id of the annotation on neurostore | [optional] 
 **snapshot** | **object** | the snapshot taken of the annotation pending a successful run of the meta-analytic algorithm | [optional] 
 **studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly] 
 **neurostore_url** | **str** |  | [optional] [readonly] 
+**cached_studyset_id** | **str** |  | [optional] 
 
 ## Example
 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of AnnotationUpdate from a JSON string
 annotation_update_instance = AnnotationUpdate.from_json(json)
 # print the JSON string representation of the object
-print AnnotationUpdate.to_json()
+print(AnnotationUpdate.to_json())
 
 # convert the object into a dict
 annotation_update_dict = annotation_update_instance.to_dict()
 # create an instance of AnnotationUpdate from a dict
-annotation_update_form_dict = annotation_update.from_dict(annotation_update_dict)
+annotation_update_from_dict = AnnotationUpdate.from_dict(annotation_update_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)