https://github.com/aces/cbrain-python-client
Python API library for CBRAIN, generated by Swagger CodeGen
https://github.com/aces/cbrain-python-client
Last synced: about 2 months ago
JSON representation
Python API library for CBRAIN, generated by Swagger CodeGen
- Host: GitHub
- URL: https://github.com/aces/cbrain-python-client
- Owner: aces
- Created: 2022-05-18T16:31:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-18T17:03:25.000Z (about 4 years ago)
- Last Synced: 2025-01-16T20:18:49.469Z (over 1 year ago)
- Language: Python
- Size: 85.9 KB
- Stars: 0
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CBRAIN Python API Client
API for interacting with the CBRAIN Platform
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 6.2.0.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
- Swagger specification: https://app.swaggerhub.com/apis/prioux/CBRAIN/6.2.0.1
For more information, please visit [https://github.com/aces/cbrain](https://github.com/aces/cbrain)
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/aces/cbrain-python-client.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/aces/cbrain-python-client.git`)
Then import the package:
```python
import cbrain_api
```
### 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 cbrain_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import cbrain_api
from cbrain_api.rest import ApiException
from pprint import pprint
# Configure API key authorization: BrainPortalSession
configuration = cbrain_api.Configuration()
configuration.api_key['cbrain_api_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cbrain_api_token'] = 'Bearer'
# create an instance of the API class
api_instance = cbrain_api.BourreauxApi(cbrain_api.ApiClient(configuration))
page = 56 # int | Page number when paginating. See also the per_page parameter (optional)
per_page = 56 # int | Size of each page when paginating. See also the page parameter (optional)
try:
# Get a list of the Bourreaux available to be used by the current user.
api_response = api_instance.bourreaux_get(page=page, per_page=per_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling BourreauxApi->bourreaux_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:3000*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BourreauxApi* | [**bourreaux_get**](docs/BourreauxApi.md#bourreaux_get) | **GET** /bourreaux | Get a list of the Bourreaux available to be used by the current user.
*BourreauxApi* | [**bourreaux_id_get**](docs/BourreauxApi.md#bourreaux_id_get) | **GET** /bourreaux/{id} | Get information about a Bourreau.
*DataProvidersApi* | [**data_providers_get**](docs/DataProvidersApi.md#data_providers_get) | **GET** /data_providers | Get a list of the Data Providers available to the current user.
*DataProvidersApi* | [**data_providers_id_browse_get**](docs/DataProvidersApi.md#data_providers_id_browse_get) | **GET** /data_providers/{id}/browse | List the files on a Data Provider.
*DataProvidersApi* | [**data_providers_id_delete_post**](docs/DataProvidersApi.md#data_providers_id_delete_post) | **POST** /data_providers/{id}/delete | Deletes unregistered files from a CBRAIN Data provider.
*DataProvidersApi* | [**data_providers_id_get**](docs/DataProvidersApi.md#data_providers_id_get) | **GET** /data_providers/{id} | Get information on a particular Data Provider.
*DataProvidersApi* | [**data_providers_id_is_alive_get**](docs/DataProvidersApi.md#data_providers_id_is_alive_get) | **GET** /data_providers/{id}/is_alive | Pings a Data Provider to check if it is running.
*DataProvidersApi* | [**data_providers_id_register_post**](docs/DataProvidersApi.md#data_providers_id_register_post) | **POST** /data_providers/{id}/register | Registers a file as a Userfile in CBRAIN.
*DataProvidersApi* | [**data_providers_id_unregister_post**](docs/DataProvidersApi.md#data_providers_id_unregister_post) | **POST** /data_providers/{id}/unregister | Unregisters files as Userfile in CBRAIN.
*GroupsApi* | [**groups_get**](docs/GroupsApi.md#groups_get) | **GET** /groups | Get a list of the Groups (projects) available to the current user.
*GroupsApi* | [**groups_id_delete**](docs/GroupsApi.md#groups_id_delete) | **DELETE** /groups/{id} | Deletes a Group (project).
*GroupsApi* | [**groups_id_get**](docs/GroupsApi.md#groups_id_get) | **GET** /groups/{id} | Get information on a Group (project).
*GroupsApi* | [**groups_id_put**](docs/GroupsApi.md#groups_id_put) | **PUT** /groups/{id} | Update the properties of a Group (project).
*GroupsApi* | [**groups_post**](docs/GroupsApi.md#groups_post) | **POST** /groups | Creates a new Group.
*SessionsApi* | [**session_delete**](docs/SessionsApi.md#session_delete) | **DELETE** /session | Destroy the current session
*SessionsApi* | [**session_get**](docs/SessionsApi.md#session_get) | **GET** /session | Get session information
*SessionsApi* | [**session_post**](docs/SessionsApi.md#session_post) | **POST** /session | Create a new session
*TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | Get a list of the tags currently in CBRAIN.
*TagsApi* | [**tags_id_delete**](docs/TagsApi.md#tags_id_delete) | **DELETE** /tags/{id} | Delete a tag.
*TagsApi* | [**tags_id_get**](docs/TagsApi.md#tags_id_get) | **GET** /tags/{id} | Get one tag.
*TagsApi* | [**tags_id_put**](docs/TagsApi.md#tags_id_put) | **PUT** /tags/{id} | Update a tag.
*TagsApi* | [**tags_post**](docs/TagsApi.md#tags_post) | **POST** /tags | Create a new tag.
*TasksApi* | [**tasks_get**](docs/TasksApi.md#tasks_get) | **GET** /tasks | Get the list of Tasks.
*TasksApi* | [**tasks_id_get**](docs/TasksApi.md#tasks_id_get) | **GET** /tasks/{id} | Get information on a Task.
*TasksApi* | [**tasks_post**](docs/TasksApi.md#tasks_post) | **POST** /tasks | Create a new Task.
*ToolConfigsApi* | [**tool_configs_get**](docs/ToolConfigsApi.md#tool_configs_get) | **GET** /tool_configs | Get a list of tool versions installed.
*ToolConfigsApi* | [**tool_configs_id_get**](docs/ToolConfigsApi.md#tool_configs_id_get) | **GET** /tool_configs/{id} | Get information about a particular tool configuration
*ToolsApi* | [**tools_get**](docs/ToolsApi.md#tools_get) | **GET** /tools | Get the list of Tools.
*UserfilesApi* | [**userfiles_change_provider_post**](docs/UserfilesApi.md#userfiles_change_provider_post) | **POST** /userfiles/change_provider | Moves the Userfiles from their current Data Provider to a new one.
*UserfilesApi* | [**userfiles_compress_post**](docs/UserfilesApi.md#userfiles_compress_post) | **POST** /userfiles/compress | Compresses many Userfiles each into their own GZIP archive.
*UserfilesApi* | [**userfiles_delete_files_delete**](docs/UserfilesApi.md#userfiles_delete_files_delete) | **DELETE** /userfiles/delete_files | Delete several files that have been registered as Userfiles
*UserfilesApi* | [**userfiles_download_post**](docs/UserfilesApi.md#userfiles_download_post) | **POST** /userfiles/download | Download several files
*UserfilesApi* | [**userfiles_get**](docs/UserfilesApi.md#userfiles_get) | **GET** /userfiles | List of the Userfiles accessible to the current user.
*UserfilesApi* | [**userfiles_id_content_get**](docs/UserfilesApi.md#userfiles_id_content_get) | **GET** /userfiles/{id}/content | Get the content of a Userfile
*UserfilesApi* | [**userfiles_id_get**](docs/UserfilesApi.md#userfiles_id_get) | **GET** /userfiles/{id} | Get information on a Userfile.
*UserfilesApi* | [**userfiles_id_put**](docs/UserfilesApi.md#userfiles_id_put) | **PUT** /userfiles/{id} | Update information on a Userfile.
*UserfilesApi* | [**userfiles_post**](docs/UserfilesApi.md#userfiles_post) | **POST** /userfiles | Creates a new Userfile and upload its content.
*UserfilesApi* | [**userfiles_sync_multiple_post**](docs/UserfilesApi.md#userfiles_sync_multiple_post) | **POST** /userfiles/sync_multiple | Syncs Userfiles to the local Data Providers cache.
*UserfilesApi* | [**userfiles_uncompress_post**](docs/UserfilesApi.md#userfiles_uncompress_post) | **POST** /userfiles/uncompress | Uncompresses many Userfiles.
*UsersApi* | [**users_get**](docs/UsersApi.md#users_get) | **GET** /users | Returns all of the users in CBRAIN. Only available to admins.
*UsersApi* | [**users_id_delete**](docs/UsersApi.md#users_id_delete) | **DELETE** /users/{id} | Deletes a CBRAIN user
*UsersApi* | [**users_id_get**](docs/UsersApi.md#users_id_get) | **GET** /users/{id} | Returns information about a user
*UsersApi* | [**users_id_patch**](docs/UsersApi.md#users_id_patch) | **PATCH** /users/{id} | Update information about a user
*UsersApi* | [**users_post**](docs/UsersApi.md#users_post) | **POST** /users | Create a new user in CBRAIN. Only available to admins.
## Documentation For Models
- [Bourreau](docs/Bourreau.md)
- [CbrainTask](docs/CbrainTask.md)
- [CbrainTaskModReq](docs/CbrainTaskModReq.md)
- [DataProvider](docs/DataProvider.md)
- [FileInfo](docs/FileInfo.md)
- [Group](docs/Group.md)
- [GroupModReq](docs/GroupModReq.md)
- [MultiRegistrationModReq](docs/MultiRegistrationModReq.md)
- [MultiUserfilesModReq](docs/MultiUserfilesModReq.md)
- [RegistrationInfo](docs/RegistrationInfo.md)
- [SessionInfo](docs/SessionInfo.md)
- [Tag](docs/Tag.md)
- [TagModReq](docs/TagModReq.md)
- [Tool](docs/Tool.md)
- [ToolConfig](docs/ToolConfig.md)
- [User](docs/User.md)
- [UserModReq](docs/UserModReq.md)
- [Userfile](docs/Userfile.md)
- [UserfileModReq](docs/UserfileModReq.md)
## Documentation For Authorization
## BrainPortalSession
- **Type**: API key
- **API key parameter name**: cbrain_api_token
- **Location**: URL query string
## Author
The CBRAIN team