hidebound
0.34.2

Getting Started

  • Overview
  • Installation for Developers
  • Installation for Production
  • Dataflow
  • Workflow
  • Naming Convention
  • Project Structure
  • Application
  • Configuration
  • Specification
  • Production CLI
  • Quickstart Guide
  • Development CLI

Python API

  • core
  • exporters
  • server

Development CLI

  • cli
hidebound
  • <no title>
  • View page source

  • core
    • config
      • Config
        • Config.ingress_directory
        • Config.staging_directory
        • Config.include_regex
        • Config.exclude_regex
        • Config.write_mode
        • Config.workflow
        • Config.redact_regex
        • Config.redact_hash
        • Config.specification_files
        • Config.exporters
        • Config.webhooks
        • Config.dask
        • Config.WebhookConfig
        • Config._schema
        • Config.dask
        • Config.exclude_regex
        • Config.exporters
        • Config.include_regex
        • Config.ingress_directory
        • Config.redact_hash
        • Config.redact_regex
        • Config.specification_files
        • Config.staging_directory
        • Config.webhooks
        • Config.workflow
        • Config.write_mode
      • is_specification_file()
    • connection
      • DaskConnection
        • DaskConnection.__init__()
        • DaskConnection.cluster_type
        • DaskConnection.gateway_config
        • DaskConnection.local_config
        • DaskConnection.num_partitions
      • DaskConnectionConfig
        • DaskConnectionConfig.cluster_type
        • DaskConnectionConfig.num_partitions
        • DaskConnectionConfig.local_num_workers
        • DaskConnectionConfig.local_threads_per_worker
        • DaskConnectionConfig.local_multiprocessing
        • DaskConnectionConfig.gateway_address
        • DaskConnectionConfig.gateway_proxy_address
        • DaskConnectionConfig.gateway_public_address
        • DaskConnectionConfig.gateway_auth_type
        • DaskConnectionConfig.gateway_api_token
        • DaskConnectionConfig.gateway_api_user
        • DaskConnectionConfig.gateway_cluster_options
        • DaskConnectionConfig.gateway_min_workers
        • DaskConnectionConfig.gateway_max_workers
        • DaskConnectionConfig.gateway_shutdown_on_close
        • DaskConnectionConfig.gateway_timeout
        • DaskConnectionConfig.ClusterOption
        • DaskConnectionConfig._schema
        • DaskConnectionConfig.cluster_type
        • DaskConnectionConfig.gateway_address
        • DaskConnectionConfig.gateway_api_token
        • DaskConnectionConfig.gateway_api_user
        • DaskConnectionConfig.gateway_auth_type
        • DaskConnectionConfig.gateway_cluster_options
        • DaskConnectionConfig.gateway_max_workers
        • DaskConnectionConfig.gateway_min_workers
        • DaskConnectionConfig.gateway_proxy_address
        • DaskConnectionConfig.gateway_public_address
        • DaskConnectionConfig.gateway_shutdown_on_close
        • DaskConnectionConfig.gateway_timeout
        • DaskConnectionConfig.local_multiprocessing
        • DaskConnectionConfig.local_num_workers
        • DaskConnectionConfig.local_threads_per_worker
        • DaskConnectionConfig.num_partitions
    • database
      • Database
        • Database.__init__()
        • Database.call_webhooks()
        • Database.create()
        • Database.delete()
        • Database.export()
        • Database.from_config()
        • Database.from_json()
        • Database.from_yaml()
        • Database.read()
        • Database.search()
        • Database.update()
    • database_tools
      • DF
      • add_asset_id()
      • add_asset_name()
      • add_asset_path()
      • add_asset_traits()
      • add_asset_type()
      • add_file_traits()
      • add_relative_path()
      • add_specification()
      • cleanup()
      • get_data_for_write()
      • validate_assets()
      • validate_filepath()
    • logging
      • DummyLogger
        • DummyLogger.critical()
        • DummyLogger.debug()
        • DummyLogger.error()
        • DummyLogger.fatal()
        • DummyLogger.info()
        • DummyLogger.warning()
      • ProgressLogger
        • ProgressLogger.__init__()
        • ProgressLogger._get_logger()
        • ProgressLogger.critical()
        • ProgressLogger.debug()
        • ProgressLogger.error()
        • ProgressLogger.fatal()
        • ProgressLogger.filepath
        • ProgressLogger.info()
        • ProgressLogger.log()
        • ProgressLogger.logs
        • ProgressLogger.read()
        • ProgressLogger.warning()
      • get_progress()
    • parser
      • AssetNameParser
        • AssetNameParser.COORDINATE_INDICATOR
        • AssetNameParser.COORDINATE_PADDING
        • AssetNameParser.DESCRIPTOR_INDICATOR
        • AssetNameParser.EXTENSION_INDICATOR
        • AssetNameParser.FIELD_SEPARATOR
        • AssetNameParser.FRAME_INDICATOR
        • AssetNameParser.FRAME_PADDING
        • AssetNameParser.LEGAL_FIELDS
        • AssetNameParser.PROJECT_INDICATOR
        • AssetNameParser.SPECIFICATION_INDICATOR
        • AssetNameParser.TOKEN_SEPARATOR
        • AssetNameParser.VERSION_INDICATOR
        • AssetNameParser.VERSION_PADDING
        • AssetNameParser.__init__()
        • AssetNameParser._get_extension_parser()
        • AssetNameParser._get_grammar()
        • AssetNameParser._get_parser()
        • AssetNameParser._get_specification_parser()
        • AssetNameParser._raise_field_error()
        • AssetNameParser.parse()
        • AssetNameParser.parse_specification()
        • AssetNameParser.to_string()
    • specification_base
      • ComplexSpecificationBase
        • ComplexSpecificationBase.asset_type
        • ComplexSpecificationBase._schema
        • ComplexSpecificationBase.asset_type
        • ComplexSpecificationBase.descriptor
        • ComplexSpecificationBase.extension
        • ComplexSpecificationBase.project
        • ComplexSpecificationBase.specification
        • ComplexSpecificationBase.version
      • FileSpecificationBase
        • FileSpecificationBase.asset_type
        • FileSpecificationBase._schema
        • FileSpecificationBase.asset_type
        • FileSpecificationBase.descriptor
        • FileSpecificationBase.extension
        • FileSpecificationBase.get_asset_path()
        • FileSpecificationBase.project
        • FileSpecificationBase.specification
        • FileSpecificationBase.to_filepaths()
        • FileSpecificationBase.version
      • SequenceSpecificationBase
        • SequenceSpecificationBase.asset_type
        • SequenceSpecificationBase._schema
        • SequenceSpecificationBase.asset_type
        • SequenceSpecificationBase.descriptor
        • SequenceSpecificationBase.extension
        • SequenceSpecificationBase.get_asset_path()
        • SequenceSpecificationBase.project
        • SequenceSpecificationBase.specification
        • SequenceSpecificationBase.to_filepaths()
        • SequenceSpecificationBase.version
      • SpecificationBase
        • SpecificationBase.asset_type
        • SpecificationBase.filename_fields
        • SpecificationBase.asset_name_fields
        • SpecificationBase.project
        • SpecificationBase.descriptor
        • SpecificationBase.version
        • SpecificationBase.extension
        • SpecificationBase.__init__()
        • SpecificationBase._schema
        • SpecificationBase._to_filepaths()
        • SpecificationBase.asset_name_fields
        • SpecificationBase.asset_type
        • SpecificationBase.descriptor
        • SpecificationBase.extension
        • SpecificationBase.file_traits
        • SpecificationBase.filename_fields
        • SpecificationBase.get_asset_id()
        • SpecificationBase.get_asset_name()
        • SpecificationBase.get_asset_path()
        • SpecificationBase.get_file_traits()
        • SpecificationBase.get_filename_traits()
        • SpecificationBase.get_name_patterns()
        • SpecificationBase.get_traits()
        • SpecificationBase.project
        • SpecificationBase.specification
        • SpecificationBase.validate_filepath()
        • SpecificationBase.version
    • specifications
      • Raw001
        • Raw001.filename_fields
        • Raw001.asset_name_fields
        • Raw001.height
        • Raw001.width
        • Raw001.extension
        • Raw001._schema
        • Raw001.asset_name_fields
        • Raw001.channels
        • Raw001.descriptor
        • Raw001.extension
        • Raw001.file_traits
        • Raw001.filename_fields
        • Raw001.frame
        • Raw001.height
        • Raw001.project
        • Raw001.specification
        • Raw001.version
        • Raw001.width
      • Raw002
        • Raw002.filename_fields
        • Raw002.asset_name_fields
        • Raw002.height
        • Raw002.width
        • Raw002.extension
        • Raw002._schema
        • Raw002.asset_name_fields
        • Raw002.channels
        • Raw002.coordinate
        • Raw002.descriptor
        • Raw002.extension
        • Raw002.file_traits
        • Raw002.filename_fields
        • Raw002.frame
        • Raw002.height
        • Raw002.project
        • Raw002.specification
        • Raw002.version
        • Raw002.width
    • tools
      • DFS
      • delete_empty_directories()
      • directory_to_dataframe()
      • error_to_string()
      • get_lut()
      • get_meta_kwargs()
      • lut_combinator()
      • pred_combinator()
      • read_json()
      • str_to_bool()
      • time_string()
      • to_prototype()
      • traverse_directory()
      • write_json()
    • traits
      • get_image_height()
      • get_image_width()
      • get_num_image_channels()
    • validators
      • coordinates_begin_at()
      • has_dense_coordinates()
      • has_uniform_coordinate_count()
      • is_attribute_of()
      • is_aws_region()
      • is_bucket_name()
      • is_cluster_option_type()
      • is_coordinate()
      • is_descriptor()
      • is_directory()
      • is_eq()
      • is_extension()
      • is_file()
      • is_frame()
      • is_gt()
      • is_gte()
      • is_hidebound_directory()
      • is_homogenous()
      • is_http_method()
      • is_in()
      • is_legal_directory()
      • is_lt()
      • is_lte()
      • is_metadata_type()
      • is_not_missing_values()
      • is_one_of()
      • is_project()
      • is_version()
      • is_workflow()
      • validate()
      • validate_each()
  • exporters
    • exporter_base
      • ExporterBase
        • ExporterBase.__init__()
        • ExporterBase._enforce_directory_structure()
        • ExporterBase._export_asset()
        • ExporterBase._export_asset_chunk()
        • ExporterBase._export_content()
        • ExporterBase._export_file()
        • ExporterBase._export_file_chunk()
        • ExporterBase.export()
      • ExporterConfigBase
        • ExporterConfigBase.metadata_types
        • ExporterConfigBase.dask
        • ExporterConfigBase._schema
        • ExporterConfigBase.dask
        • ExporterConfigBase.metadata_types
    • girder_exporter
      • GirderConfig
        • GirderConfig.name
        • GirderConfig.api_key
        • GirderConfig.root_id
        • GirderConfig.root_type
        • GirderConfig.host
        • GirderConfig.port
        • GirderConfig.metadata_types
        • GirderConfig._schema
        • GirderConfig.api_key
        • GirderConfig.host
        • GirderConfig.metadata_types
        • GirderConfig.name
        • GirderConfig.port
        • GirderConfig.root_id
        • GirderConfig.root_type
      • GirderExporter
        • GirderExporter.__init__()
        • GirderExporter._export_asset()
        • GirderExporter._export_asset_chunk()
        • GirderExporter._export_content()
        • GirderExporter._export_dirs()
        • GirderExporter._export_file()
        • GirderExporter._export_file_chunk()
        • GirderExporter.from_config()
    • disk_exporter
      • DiskConfig
        • DiskConfig.name
        • DiskConfig.target_directory
        • DiskConfig._schema
        • DiskConfig.dask
        • DiskConfig.metadata_types
        • DiskConfig.name
        • DiskConfig.target_directory
      • DiskExporter
        • DiskExporter.__init__()
        • DiskExporter._export_asset()
        • DiskExporter._export_asset_chunk()
        • DiskExporter._export_content()
        • DiskExporter._export_file()
        • DiskExporter._export_file_chunk()
        • DiskExporter.from_config()
    • s3_exporter
      • S3Config
        • S3Config.name
        • S3Config.access_key
        • S3Config.secret_key
        • S3Config.bucket
        • S3Config.region
        • S3Config._schema
        • S3Config.access_key
        • S3Config.bucket
        • S3Config.dask
        • S3Config.metadata_types
        • S3Config.name
        • S3Config.region
        • S3Config.secret_key
      • S3Exporter
        • S3Exporter.__init__()
        • S3Exporter._export_asset()
        • S3Exporter._export_asset_chunk()
        • S3Exporter._export_content()
        • S3Exporter._export_file()
        • S3Exporter._export_file_chunk()
        • S3Exporter.from_config()
  • server
    • api
      • api()
      • create()
      • delete()
      • export()
      • handle_data_error()
      • handle_json_decode_error()
      • handle_key_error()
      • handle_type_error()
      • initialize()
      • progress()
      • read()
      • search()
      • update()
      • workflow()
    • app
      • get_app()
      • liveness()
      • on_datatable_update()
      • on_event()
      • on_get_tab()
      • on_progress()
      • readiness()
      • serve_stylesheet()
    • components
      • get_asset_graph()
      • get_button()
      • get_config_tab()
      • get_configbar()
      • get_dash_app()
      • get_data_tab()
      • get_datatable()
      • get_dropdown()
      • get_dummy_elements()
      • get_key_value_card()
      • get_progressbar()
      • get_searchbar()
    • extension
      • HideboundExtension
        • HideboundExtension.__init__()
        • HideboundExtension._get_config_from_env()
        • HideboundExtension._get_config_from_file()
        • HideboundExtension.get_config()
        • HideboundExtension.init_app()
    • extensions
    • server_tools
      • EndPoints
        • EndPoints.api
        • EndPoints.create
        • EndPoints.delete
        • EndPoints.export
        • EndPoints.host
        • EndPoints.init
        • EndPoints.port
        • EndPoints.progress
        • EndPoints.read
        • EndPoints.search
        • EndPoints.update
        • EndPoints.workflow
      • error_to_response()
      • format_config()
      • get_config_error()
      • get_connection_error()
      • get_initialization_error()
      • get_progress()
      • get_read_error()
      • get_search_error()
      • get_update_error()
      • parse_json_file_content()
      • render_template()
      • request()
      • search()
      • setup_hidebound_directories()
Previous Next

© Copyright 2024, Alex Braun <alexander.g.braun@gmail.com>.

Built with Sphinx using a theme provided by Read the Docs.