QMENTA Core lib documentation

Note

This is the QMENTA Core library to interact with the QMENTA platform.

You can install the library using PyPI, check Installation

Suggestions and requests are welcomed at dev@qmenta.com.

Contents:

• Installation
• Tutorial
  • Login to your account
  • Projects
  • Subjects
    • Get existing subjects
    • Create a new session
    • Upload data
• API Reference
  • qmenta.core.auth
    • Auth
      • Auth.base_url
      • Auth.token
      • Auth.from_env()
      • Auth.get_session()
      • Auth.login()
      • Auth.qmenta_auth_env_file()
    • InvalidLoginError
    • Needs2FAError
    • main()
    • validate_url()
    • write_dot_env_file()
  • qmenta.core.platform
    • ChooseDataError
    • parse_response()
    • post()
  • qmenta.core.upload
    • FileInfo
      • FileInfo.add_to_container_id
      • FileInfo.date_of_scan
      • FileInfo.description
      • FileInfo.input_data_type
      • FileInfo.is_result
      • FileInfo.name
      • FileInfo.project_id
      • FileInfo.session_id
      • FileInfo.split_data
      • FileInfo.subject_name
    • SingleUpload
      • SingleUpload.input_filename
      • SingleUpload.upload_filename
      • SingleUpload.upload_id
      • SingleUpload.file_size
      • SingleUpload.status_message
      • SingleUpload.bytes_uploaded
      • SingleUpload.start()
      • SingleUpload.status
    • UploadAlreadyDoneError
    • UploadAlreadyStartedError
    • UploadError
    • UploadStatus
      • UploadStatus.ANONYMISING
      • UploadStatus.DELETING_TMP_FILES
      • UploadStatus.DONE
      • UploadStatus.FAILED
      • UploadStatus.TO_ANONYMISE
      • UploadStatus.TO_CLEAN
      • UploadStatus.TO_UPLOAD
      • UploadStatus.TO_ZIP
      • UploadStatus.TO_ZIP_AND_ANONYMISE
      • UploadStatus.UPLOADING
      • UploadStatus.ZIPPING
    • MultipleThreadedUploads
      • MultipleThreadedUploads.upload_list
      • MultipleThreadedUploads.uploads_in_progress
      • MultipleThreadedUploads.add_upload()
      • MultipleThreadedUploads.max_parallel_uploads
  • qmenta.core.errors
    • ActionFailedError
    • CannotReadFileError
    • ConnectionError
    • Error
    • InvalidResponseError
    • PlatformError

Indices and tables

• Index

• Search Page