clams package

API documentation

• clams.app package
  • ClamsApp
    • ClamsApp._RAW_PARAMS_KEY
    • ClamsApp._abc_impl
    • ClamsApp._annotate()
    • ClamsApp._appmetadata()
    • ClamsApp._check_mmif_compatibility()
    • ClamsApp._load_appmetadata()
    • ClamsApp._refine_params()
    • ClamsApp.annotate()
    • ClamsApp.appmetadata()
    • ClamsApp.get_configuration()
    • ClamsApp.open_document_location()
    • ClamsApp.record_error()
    • ClamsApp.set_error_view()
    • ClamsApp.sign_view()
    • ClamsApp.universal_parameters
    • ClamsApp.validate_document_locations()
• clams.appmetadata package
  • AppMetadata
    • AppMetadata.add_input()
    • AppMetadata.add_more()
    • AppMetadata.add_output()
    • AppMetadata.add_parameter()
    • AppMetadata.model_config
  • Input
    • Input.add_description()
    • Input.copy()
    • Input.model_config
    • Input.model_construct()
    • Input.model_copy()
    • Input.model_dump()
    • Input.model_dump_json()
    • Input.model_extra
    • Input.model_fields_set
    • Input.model_json_schema()
    • Input.model_parametrized_name()
    • Input.model_post_init()
    • Input.model_rebuild()
    • Input.model_validate()
    • Input.model_validate_json()
    • Input.model_validate_strings()
  • Output
    • Output.add_description()
    • Output.copy()
    • Output.model_config
    • Output.model_construct()
    • Output.model_copy()
    • Output.model_dump()
    • Output.model_dump_json()
    • Output.model_extra
    • Output.model_fields_set
    • Output.model_json_schema()
    • Output.model_parametrized_name()
    • Output.model_post_init()
    • Output.model_rebuild()
    • Output.model_validate()
    • Output.model_validate_json()
    • Output.model_validate_strings()
  • RuntimeParameter
    • RuntimeParameter.copy()
    • RuntimeParameter.model_config
    • RuntimeParameter.model_construct()
    • RuntimeParameter.model_copy()
    • RuntimeParameter.model_dump()
    • RuntimeParameter.model_dump_json()
    • RuntimeParameter.model_extra
    • RuntimeParameter.model_fields_set
    • RuntimeParameter.model_json_schema()
    • RuntimeParameter.model_parametrized_name()
    • RuntimeParameter.model_post_init()
    • RuntimeParameter.model_rebuild()
    • RuntimeParameter.model_validate()
    • RuntimeParameter.model_validate_json()
    • RuntimeParameter.model_validate_strings()
• clams.restify package
  • ClamsHTTPApi
    • ClamsHTTPApi.get()
    • ClamsHTTPApi.json_to_response()
    • ClamsHTTPApi.methods
    • ClamsHTTPApi.post()
    • ClamsHTTPApi.put()
  • Restifier
    • Restifier.run()
    • Restifier.serve_development()
    • Restifier.serve_production()
    • Restifier.test_client()
• clams.mmif_utils package
  • rewind module
  • source module