{"id":20566197,"url":"https://github.com/aces/cbrain-python-client","last_synced_at":"2026-04-22T04:02:03.008Z","repository":{"id":139175217,"uuid":"493742802","full_name":"aces/cbrain-python-client","owner":"aces","description":"Python API library for CBRAIN, generated by Swagger CodeGen","archived":false,"fork":false,"pushed_at":"2022-05-18T17:03:25.000Z","size":88,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-16T20:18:49.469Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aces.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-18T16:31:20.000Z","updated_at":"2022-05-18T16:35:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"40316523-8f46-4d5c-b8d7-6bcdc12ed4ef","html_url":"https://github.com/aces/cbrain-python-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-python-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-python-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-python-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-python-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aces","download_url":"https://codeload.github.com/aces/cbrain-python-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242179256,"owners_count":20084940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T04:40:32.787Z","updated_at":"2026-04-22T04:01:57.988Z","avatar_url":"https://github.com/aces.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CBRAIN Python API Client\nAPI for interacting with the CBRAIN Platform\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 6.2.0.1\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n- Swagger specification: https://app.swaggerhub.com/apis/prioux/CBRAIN/6.2.0.1\n\nFor more information, please visit [https://github.com/aces/cbrain](https://github.com/aces/cbrain)\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/aces/cbrain-python-client.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/aces/cbrain-python-client.git`)\n\nThen import the package:\n```python\nimport cbrain_api \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cbrain_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport cbrain_api\nfrom cbrain_api.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: BrainPortalSession\nconfiguration = cbrain_api.Configuration()\nconfiguration.api_key['cbrain_api_token'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cbrain_api_token'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = cbrain_api.BourreauxApi(cbrain_api.ApiClient(configuration))\npage = 56 # int | Page number when paginating. See also the per_page parameter (optional)\nper_page = 56 # int | Size of each page when paginating. See also the page parameter (optional)\n\ntry:\n    # Get a list of the Bourreaux available to be used by the current user.\n    api_response = api_instance.bourreaux_get(page=page, per_page=per_page)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling BourreauxApi-\u003ebourreaux_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:3000*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BourreauxApi* | [**bourreaux_get**](docs/BourreauxApi.md#bourreaux_get) | **GET** /bourreaux | Get a list of the Bourreaux available to be used by the current user.\n*BourreauxApi* | [**bourreaux_id_get**](docs/BourreauxApi.md#bourreaux_id_get) | **GET** /bourreaux/{id} | Get information about a Bourreau.\n*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.\n*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.\n*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.\n*DataProvidersApi* | [**data_providers_id_get**](docs/DataProvidersApi.md#data_providers_id_get) | **GET** /data_providers/{id} | Get information on a particular Data Provider.\n*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.\n*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.\n*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.\n*GroupsApi* | [**groups_get**](docs/GroupsApi.md#groups_get) | **GET** /groups | Get a list of the Groups (projects) available to the current user.\n*GroupsApi* | [**groups_id_delete**](docs/GroupsApi.md#groups_id_delete) | **DELETE** /groups/{id} | Deletes a Group (project).\n*GroupsApi* | [**groups_id_get**](docs/GroupsApi.md#groups_id_get) | **GET** /groups/{id} | Get information on a Group (project).\n*GroupsApi* | [**groups_id_put**](docs/GroupsApi.md#groups_id_put) | **PUT** /groups/{id} | Update the properties of a Group (project).\n*GroupsApi* | [**groups_post**](docs/GroupsApi.md#groups_post) | **POST** /groups | Creates a new Group.\n*SessionsApi* | [**session_delete**](docs/SessionsApi.md#session_delete) | **DELETE** /session | Destroy the current session\n*SessionsApi* | [**session_get**](docs/SessionsApi.md#session_get) | **GET** /session | Get session information\n*SessionsApi* | [**session_post**](docs/SessionsApi.md#session_post) | **POST** /session | Create a new session\n*TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | Get a list of the tags currently in CBRAIN.\n*TagsApi* | [**tags_id_delete**](docs/TagsApi.md#tags_id_delete) | **DELETE** /tags/{id} | Delete a tag.\n*TagsApi* | [**tags_id_get**](docs/TagsApi.md#tags_id_get) | **GET** /tags/{id} | Get one tag.\n*TagsApi* | [**tags_id_put**](docs/TagsApi.md#tags_id_put) | **PUT** /tags/{id} | Update a tag.\n*TagsApi* | [**tags_post**](docs/TagsApi.md#tags_post) | **POST** /tags | Create a new tag.\n*TasksApi* | [**tasks_get**](docs/TasksApi.md#tasks_get) | **GET** /tasks | Get the list of Tasks.\n*TasksApi* | [**tasks_id_get**](docs/TasksApi.md#tasks_id_get) | **GET** /tasks/{id} | Get information on a Task.\n*TasksApi* | [**tasks_post**](docs/TasksApi.md#tasks_post) | **POST** /tasks | Create a new Task.\n*ToolConfigsApi* | [**tool_configs_get**](docs/ToolConfigsApi.md#tool_configs_get) | **GET** /tool_configs | Get a list of tool versions installed.\n*ToolConfigsApi* | [**tool_configs_id_get**](docs/ToolConfigsApi.md#tool_configs_id_get) | **GET** /tool_configs/{id} | Get information about a particular tool configuration\n*ToolsApi* | [**tools_get**](docs/ToolsApi.md#tools_get) | **GET** /tools | Get the list of Tools.\n*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.\n*UserfilesApi* | [**userfiles_compress_post**](docs/UserfilesApi.md#userfiles_compress_post) | **POST** /userfiles/compress | Compresses many Userfiles each into their own GZIP archive.\n*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\n*UserfilesApi* | [**userfiles_download_post**](docs/UserfilesApi.md#userfiles_download_post) | **POST** /userfiles/download | Download several files\n*UserfilesApi* | [**userfiles_get**](docs/UserfilesApi.md#userfiles_get) | **GET** /userfiles | List of the Userfiles accessible to the current user.\n*UserfilesApi* | [**userfiles_id_content_get**](docs/UserfilesApi.md#userfiles_id_content_get) | **GET** /userfiles/{id}/content | Get the content of a Userfile\n*UserfilesApi* | [**userfiles_id_get**](docs/UserfilesApi.md#userfiles_id_get) | **GET** /userfiles/{id} | Get information on a Userfile.\n*UserfilesApi* | [**userfiles_id_put**](docs/UserfilesApi.md#userfiles_id_put) | **PUT** /userfiles/{id} | Update information on a Userfile.\n*UserfilesApi* | [**userfiles_post**](docs/UserfilesApi.md#userfiles_post) | **POST** /userfiles | Creates a new Userfile and upload its content.\n*UserfilesApi* | [**userfiles_sync_multiple_post**](docs/UserfilesApi.md#userfiles_sync_multiple_post) | **POST** /userfiles/sync_multiple | Syncs Userfiles to the local Data Providers cache.\n*UserfilesApi* | [**userfiles_uncompress_post**](docs/UserfilesApi.md#userfiles_uncompress_post) | **POST** /userfiles/uncompress | Uncompresses many Userfiles.\n*UsersApi* | [**users_get**](docs/UsersApi.md#users_get) | **GET** /users | Returns all of the users in CBRAIN. Only available to admins.\n*UsersApi* | [**users_id_delete**](docs/UsersApi.md#users_id_delete) | **DELETE** /users/{id} | Deletes a CBRAIN user\n*UsersApi* | [**users_id_get**](docs/UsersApi.md#users_id_get) | **GET** /users/{id} | Returns information about a user\n*UsersApi* | [**users_id_patch**](docs/UsersApi.md#users_id_patch) | **PATCH** /users/{id} | Update information about a user\n*UsersApi* | [**users_post**](docs/UsersApi.md#users_post) | **POST** /users | Create a new user in CBRAIN. Only available to admins.\n\n\n## Documentation For Models\n\n - [Bourreau](docs/Bourreau.md)\n - [CbrainTask](docs/CbrainTask.md)\n - [CbrainTaskModReq](docs/CbrainTaskModReq.md)\n - [DataProvider](docs/DataProvider.md)\n - [FileInfo](docs/FileInfo.md)\n - [Group](docs/Group.md)\n - [GroupModReq](docs/GroupModReq.md)\n - [MultiRegistrationModReq](docs/MultiRegistrationModReq.md)\n - [MultiUserfilesModReq](docs/MultiUserfilesModReq.md)\n - [RegistrationInfo](docs/RegistrationInfo.md)\n - [SessionInfo](docs/SessionInfo.md)\n - [Tag](docs/Tag.md)\n - [TagModReq](docs/TagModReq.md)\n - [Tool](docs/Tool.md)\n - [ToolConfig](docs/ToolConfig.md)\n - [User](docs/User.md)\n - [UserModReq](docs/UserModReq.md)\n - [Userfile](docs/Userfile.md)\n - [UserfileModReq](docs/UserfileModReq.md)\n\n\n## Documentation For Authorization\n\n\n## BrainPortalSession\n\n- **Type**: API key\n- **API key parameter name**: cbrain_api_token\n- **Location**: URL query string\n\n\n## Author\n\nThe CBRAIN team\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faces%2Fcbrain-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-python-client/lists"}