sevenbridges package

sevenbridges-python

copyright:2016 Seven Bridges Genomics Inc. license:Apache 2.0

Subpackages

• sevenbridges.http package
  • Submodules
  • sevenbridges.http.client module
  • sevenbridges.http.error_handlers module
• sevenbridges.meta package
  • Submodules
  • sevenbridges.meta.collection module
  • sevenbridges.meta.comp_mutable_dict module
  • sevenbridges.meta.data module
  • sevenbridges.meta.fields module
  • sevenbridges.meta.resource module
  • sevenbridges.meta.transformer module
• sevenbridges.models package
  • Subpackages
    • sevenbridges.models.compound package
      • Subpackages
        • sevenbridges.models.compound.billing package
          • Submodules
          • sevenbridges.models.compound.billing.invoice_period module
          • sevenbridges.models.compound.billing.project_breakdown module
          • sevenbridges.models.compound.billing.task_breakdown module
        • sevenbridges.models.compound.files package
          • Submodules
          • sevenbridges.models.compound.files.download_info module
          • sevenbridges.models.compound.files.file_origin module
          • sevenbridges.models.compound.files.file_storage module
          • sevenbridges.models.compound.files.metadata module
        • sevenbridges.models.compound.jobs package
          • Submodules
          • sevenbridges.models.compound.jobs.job module
          • sevenbridges.models.compound.jobs.job_docker module
          • sevenbridges.models.compound.jobs.job_instance module
          • sevenbridges.models.compound.jobs.job_log module
        • sevenbridges.models.compound.projects package
          • Submodules
          • sevenbridges.models.compound.projects.permissions module
          • sevenbridges.models.compound.projects.settings module
        • sevenbridges.models.compound.tasks package
          • Submodules
          • sevenbridges.models.compound.tasks.batch_by module
          • sevenbridges.models.compound.tasks.batch_group module
          • sevenbridges.models.compound.tasks.execution_status module
          • sevenbridges.models.compound.tasks.input module
          • sevenbridges.models.compound.tasks.output module
        • sevenbridges.models.compound.volumes package
          • Submodules
          • sevenbridges.models.compound.volumes.credentials module
          • sevenbridges.models.compound.volumes.import_destination module
          • sevenbridges.models.compound.volumes.properties module
          • sevenbridges.models.compound.volumes.service module
          • sevenbridges.models.compound.volumes.volume_file module
      • Submodules
      • sevenbridges.models.compound.error module
      • sevenbridges.models.compound.price module
  • 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
• sevenbridges.transfer package
  • Submodules
  • sevenbridges.transfer.download module
  • sevenbridges.transfer.upload module
  • sevenbridges.transfer.utils module

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

exception sevenbridges.errors.ServiceUnavailable(code=None, message=None, more_info=None)

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

exception sevenbridges.errors.Unauthorized(code=None, message=None, more_info=None)

Bases: sevenbridges.errors.SbgError

exception sevenbridges.errors.ValidationError(message)

Bases: sevenbridges.errors.SbgError