LabInform Logo
0.1

Contents:

  • Target audience
  • Introduction
  • Concepts
  • Components
  • Subpackages
LabInform
  • API documentation
  • View page source

API documentation

This is the definite source of information for developers, besides having a look at the actual source code. Each class and public method should be fully documented.

Subpackages

  • datasafe subpackage
    • datasafe.datasafe module
      • Datasafe
        • Datasafe.checksum_name
        • Datasafe.checksum_data_name
        • Datasafe.manifest_name
        • Datasafe.basic_loi
        • Datasafe.data_movement_name
        • Datasafe.metadata_extensions
        • Datasafe.add_directory()
        • Datasafe.compare_checksum()
        • Datasafe.dir_is_empty()
        • Datasafe.find_highest()
        • Datasafe.generate()
        • Datasafe.has_dir()
        • Datasafe.increment()
        • Datasafe.index()
        • Datasafe.loi_to_path()
        • Datasafe.make_both_checksum_files()
        • Datasafe.make_checksum_file()
        • Datasafe.make_checksum_for_file()
        • Datasafe.make_checksum_for_files()
        • Datasafe.make_tgz()
        • Datasafe.moveto()
        • Datasafe.multi_push()
        • Datasafe.path
        • Datasafe.pull()
        • Datasafe.push()
        • Datasafe.retrieve_checksum()
        • Datasafe.verify_own_path()
        • Datasafe.verify_path()
      • DirectoryNotEmptyError
      • Error
      • IncorrectLoiError
      • NoChecksumFilePresentError
      • NoPathForThisLoiError
      • NoSuchDirectoryError
    • datasafe.manifest module
      • ManifestWriter
        • ManifestWriter.manifest_dict
        • ManifestWriter.version
        • ManifestWriter.type
        • ManifestWriter.file_format
        • ManifestWriter.complete
        • ManifestWriter.metadata_extensions
        • ManifestWriter.checksum_name
        • ManifestWriter.checksum_data_name
        • ManifestWriter.manifest_name
        • ManifestWriter.extension_catalogue
        • ManifestWriter.set_properties()
        • ManifestWriter.write()

© Copyright 2019-24, Till Biskup. Last updated on 2024-09-08.

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