freeports_analysis.main

This module is the one that contains the function called in order to decode the information from the pdf and to save the csv file. This is also the source code to be launched (providing the options with a dotenv file or with env variables) to mimic the behaviour of the command from commandline (to use the package as a script).

Example

`python main.py`

Functions

batch_job_confs(config)	Create a list of configurations overwritten after reading a batch file with job contextual options
get_functions(format_pdf)	Set wrapper functions PDF_FILTER, TEXT_EXTRACT and TABULARIZE to use implementation of specific PDF format
get_targets()
main(config)	Main function that expect the configuration to be already provided (for example with arguments on command line or with env variables)
pipeline(pdf_file, targets, funcs)	Apply the pipeline of actions in order to get data in csv

Exceptions

NoPDFormatDetected

Exception that should rise when the script is not capable of detecting a PDF format to use to decode the report, and no explicit format is specified

exception freeports_analysis.main.NoPDFormatDetected

Exception that should rise when the script is not capable of detecting a PDF format to use to decode the report, and no explicit format is specified

freeports_analysis.main.get_functions(format_pdf: PdfFormats)

Set wrapper functions PDF_FILTER, TEXT_EXTRACT and TABULARIZE to use implementation of specific PDF format

Parameters:

format (PdfFormats) – The format detected used to choose the decoding implementation