Documentation for classes, functions, and methods ================================================= .. module:: openva_pipeline Running the OpenVA Pipeline --------------------------- The openva_pipeline package includes two convenience functions for #. creating the Transfer Database -- a database that holds configuration settings, VA data and results, and a table for logging events and errors; and #. running through all of the steps in the openVA Pipeline .. autofunction:: openva_pipeline.run_pipeline.create_transfer_db .. autofunction:: openva_pipeline.run_pipeline.run_pipeline Main Interface -------------- The OpenVA Pipeline is run using the following function .. autoclass:: openva_pipeline.pipeline.Pipeline :inherited-members: API for Transfer Database ------------------------- .. autoclass:: openva_pipeline.transfer_db.TransferDB :inherited-members: API for ODK Briefcase --------------------- .. autoclass:: openva_pipeline.odk.ODK :inherited-members: API for OpenVA -------------- .. autoclass:: openva_pipeline.openva.OpenVA :inherited-members: API for DHIS2 ------------- .. autoclass:: openva_pipeline.dhis.DHIS :inherited-members: .. autoclass:: openva_pipeline.dhis.API :inherited-members: .. autoclass:: openva_pipeline.dhis.VerbalAutopsyEvent :inherited-members: .. autofunction:: openva_pipeline.dhis.create_db .. autofunction:: openva_pipeline.dhis.get_cod_code .. autofunction:: openva_pipeline.dhis.find_key_value Exceptions ----------- .. autoexception:: openva_pipeline.exceptions.PipelineError .. autoexception:: openva_pipeline.exceptions.DatabaseConnectionError .. autoexception:: openva_pipeline.exceptions.PipelineConfigurationError .. autoexception:: openva_pipeline.exceptions.ODKConfigurationError .. autoexception:: openva_pipeline.exceptions.OpenVAConfigurationError .. autoexception:: openva_pipeline.exceptions.DHISConfigurationError .. autoexception:: openva_pipeline.exceptions.ODKError .. autoexception:: openva_pipeline.exceptions.OpenVAError .. autoexception:: openva_pipeline.exceptions.SmartVAError .. autoexception:: openva_pipeline.exceptions.DHISError