From 025107f4fcf4307635a53357f88a179c197eb4cd Mon Sep 17 00:00:00 2001 From: Syed Date: Wed, 11 Oct 2023 10:28:02 +0530 Subject: [PATCH] updated readme --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 97c8d23..284869e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Requirements -Python 3.10+ +Python 3.10+ asyncio ## Installation @@ -28,10 +28,10 @@ path = "/home/test/ABC.pdf" extract_pdf = ExtractPDF(file_path=path) # By default, output as text -extract_pdf.extract() # Output will be located `/home/test/ABC.pdf.txt` +await extract_pdf.extract() # Output will be located `/home/test/ABC.pdf.txt` # Output as json -extract_pdf.extract(as_json=True) # Output will be located `/home/test/ABC.pdf.json` +await extract_pdf.extract(as_json=True) # Output will be located `/home/test/ABC.pdf.json` ``` > You can change the output directory with simply pass `output_dir` param @@ -42,7 +42,7 @@ from df_extract.pdf import ExtractPDF path = "/home/test/ABC.pdf" extract_pdf = ExtractPDF(file_path=path, output_dir="/home/test/output") -extract_pdf.extract() +await extract_pdf.extract() ``` #### Extract content from `PDF` with image data @@ -57,7 +57,7 @@ path = "/home/test/ABC.pdf" image_extract = ImageExtract(model_download_enabled=True) extract_pdf = ExtractPDF(file_path=path, image_extract=image_extract) -extract_pdf.extract() +await extract_pdf.extract() ``` ### 2. To extract content from `PPT` and `PPTx` @@ -71,10 +71,10 @@ path = "/home/test/DEF.pptx" extract_pptx = ExtractPPTx(file_path=path) # By default, output as text -extract_pptx.extract() # Output will be located `/home/test/DEF.pptx.txt` +await extract_pptx.extract() # Output will be located `/home/test/DEF.pptx.txt` # Output as json -extract_pptx.extract(as_json=True) # Output will be located `/home/test/DEF.pptx.json` +await extract_pptx.extract(as_json=True) # Output will be located `/home/test/DEF.pptx.json` ``` ### 3. To extract content from `Doc` and `Docx` @@ -88,10 +88,10 @@ path = "/home/test/GHI.docx" extract_docx = ExtractDocx(file_path=path) # By default, output as text -extract_docx.extract() # Output will be located `/home/test/GHI.docx.txt` +await extract_docx.extract() # Output will be located `/home/test/GHI.docx.txt` # Output as json -extract_docx.extract(as_json=True) # Output will be located `/home/test/GHI.docx.json` +await extract_docx.extract(as_json=True) # Output will be located `/home/test/GHI.docx.json` ``` ### 4. To extract content from `PNG`, `JPEG` and `JPG` @@ -105,8 +105,8 @@ path = "/home/test/JKL.png" extract_png = ExtractImage(file_path=path) # By default, output as text -extract_png.extract() # Output will be located `/home/test/JKL.png.txt` +await extract_png.extract() # Output will be located `/home/test/JKL.png.txt` # Output as json -extract_png.extract(as_json=True) # Output will be located `/home/test/JKL.png.json` +await extract_png.extract(as_json=True) # Output will be located `/home/test/JKL.png.json` ``` \ No newline at end of file