sevenbridges package¶
sevenbridges-python¶
copyright: | 2016 Seven Bridges Genomics Inc. |
---|---|
license: | Apache 2.0 |
Subpackages¶
- sevenbridges.http package
- sevenbridges.meta package
- sevenbridges.models package
- Subpackages
- sevenbridges.models.compound package
- Subpackages
- Submodules
- sevenbridges.models.compound.error module
- sevenbridges.models.compound.price module
- sevenbridges.models.compound package
- Submodules
- sevenbridges.models.app module
- sevenbridges.models.billing_breakdown module
- sevenbridges.models.billing_group module
- sevenbridges.models.endpoints module
- sevenbridges.models.enums module
- sevenbridges.models.execution_details module
- sevenbridges.models.file module
- sevenbridges.models.invoice module
- sevenbridges.models.link module
- sevenbridges.models.member module
- sevenbridges.models.project module
- sevenbridges.models.storage_export module
- sevenbridges.models.storage_import module
- sevenbridges.models.task module
- sevenbridges.models.user module
- sevenbridges.models.volume module
- Subpackages
- sevenbridges.transfer package
Submodules¶
sevenbridges.api module¶
-
class
sevenbridges.api.
Api
(url=None, token=None, oauth_token=None, config=None, timeout=None, download_max_workers=16, upload_max_workers=16, proxies=None, error_handlers=None)¶ Bases:
sevenbridges.http.client.HttpClient
Api aggregates all resource classes into single place
-
apps
¶ Central resource for managing apps.
-
billing_groups
¶ Central resource for managing billing groups.
-
endpoints
¶ Central resource for managing Endpoints.
-
exports
¶ Central resource for managing exports.
-
files
¶ Central resource for managing files.
-
imports
¶ Central resource for managing imports.
-
invoices
¶ Central resource for managing invoices.
-
projects
¶ Central resource for managing projects.
-
tasks
¶ Central resource for managing tasks.
-
users
¶ Central resource for managing tasks.
-
volumes
¶ Central resource for managing volumes.
-
sevenbridges.config module¶
-
class
sevenbridges.config.
Config
(profile=None, proxies=None)¶ Bases:
object
Utility configuration class.
-
class
sevenbridges.config.
Profile
(profile)¶ Bases:
object
-
CREDENTIALS
= '/home/docs/.sevenbridges/credentials'¶
-
PROXIES
= '/home/docs/.sevenbridges/sevenbridges-python/config'¶
-
api_endpoint
¶
-
auth_token
¶
-
proxies
¶
-
-
sevenbridges.config.
format_proxies
(proxies)¶ Helper method for request proxy key compatibility. :param proxies: Proxies dictionary :return: Dict compatible with request proxy format.
sevenbridges.decorators module¶
-
sevenbridges.decorators.
check_for_error
(func)¶ Executes the wrapped function and inspects the response object for specific errors.
-
sevenbridges.decorators.
inplace_reload
(method)¶ Executes the wrapped function and reloads the object with data returned from the server.
-
sevenbridges.decorators.
retry
(retry_count)¶ Retry decorator used during file upload and download.
sevenbridges.errors module¶
-
exception
sevenbridges.errors.
BadRequest
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
Conflict
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ExecutionDetailsInvalidTaskType
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
Forbidden
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
LocalFileAlreadyExists
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
MethodNotAllowed
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
NotFound
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
PaginationError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ReadOnlyPropertyError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
RequestTimeout
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ResourceNotModified
¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
SbgError
(message=None, code=None, status=None, more_info=None)¶ Bases:
Exception
Base class for SBG errors.
Provides a base exception for all errors that are thrown by sevenbridges-python library.
-
exception
sevenbridges.errors.
ServerError
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
TaskValidationError
(message, task=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
TooManyRequests
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ValidationError
(message)¶ Bases:
sevenbridges.errors.SbgError