tags: [gradio-custom-component, , text extraction, pdf to string] title: gradio_simpletextextractfrompdf short_description: extract text from simple pdf documents colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py
gradio_simpletextextractfrompdf
Extracts text from pdf documents
Installation
pip install gradio_simpletextextractfrompdf
Usage
import gradio as gr
from gradio_simpletextextractfrompdf import SimpleTextExtractFromPDF
def first_200_chars(text):
return text[:200]
demo = gr.Interface(
fn=first_200_chars,
inputs=SimpleTextExtractFromPDF(),
outputs=gr.Textbox(label="First 200 characters of the extracted text"),
title="Simple Text Extract From PDF",
description="""
## Component Description
This space is to demo the usage of the SimpleTextExtractFromPDF component.
This component provides a simple interface to extract text from a PDF file. The extracted text can be submitted as a string input to a function for further processing.
- **Text Extraction Only:** Only the text content is extracted from the PDF. Images and table structures are not preserved.
- **Flexible Upload Options:** Users can upload a PDF file from their device or provide a URL to the PDF.
- **Input Component:** The component is primarily designed to be used as an input, allowing users to submit the extracted text to other functions.
- **Output Display:** When used as an output component, the extracted string content is displayed in a textarea.
The demo app here uses the SimpleTextExtractFromPDF component as an input component to extract the text from a PDF file and then show the first 200 characters of the extracted text.
""",
article="""
<p>
<code>pip install gradio-simpletextextractfrompdf</code>
<br>
<a href="https://pypi.org/project/gradio-simpletextextractfrompdf/"> https://pypi.org/project/gradio-simpletextextractfrompdf/</a>
</p>
""",
)
if __name__ == "__main__":
demo.launch()
SimpleTextExtractFromPDF
Initialization
| name | type | default | description |
|---|---|---|---|
value |
str | None
|
None |
The extracted text from the file. This value is set by the component and can be submitted as an input {string} to the function. |
every |
Timer | float | None
|
None |
Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
label |
str | I18nData | None
|
None |
the label for this component, displayed above the component if `show_label` is `True` and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component corresponds to. |
inputs |
Component | Sequence[Component] | set[Component] | None
|
None |
None |
show_label |
bool | None
|
None |
if True, will display label. |
scale |
int | None
|
None |
relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
min_width |
int
|
160 |
minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
interactive |
bool | None
|
None |
if True, will be rendered as an editable textbox; if False, editing will be disabled. If not provided, this is inferred based on whether the component is used as an input or output. |
visible |
bool
|
True |
If False, component will be hidden. |
elem_id |
str | None
|
None |
An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
elem_classes |
list[str] | str | None
|
None |
An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
render |
bool
|
True |
If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
key |
int | str | tuple[int | str, ...] | None
|
None |
in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render. |
preserved_by_key |
list[str] | str | None
|
"value" |
A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor. |
Events
| name | description |
|---|---|
submit |
User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- As output: Is passed, passes the extracted text into the function - string.
- As input: Should return, expects a {string} returned from the function and sets component value to it.
def predict(
value: str | None
) -> str | None:
return value
Release files for gradio-simpletextextractfrompdf 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gradio_simpletextextractfrompdf-0.0.4.tar.gz | 2.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gradio_simpletextextractfrompdf-0.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.1 MB
Release files / gradio_simpletextextractfrompdf-0.0.4.tar.gz
| Download URL | gradio_simpletextextractfrompdf-0.0.4.tar.gz |
|---|---|
| Size | 2.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f731ebae3f439ce2e5a6c89f5871f25041e11b1070b9992d3fbd200b392c45c0
|
|
BLAKE2b-256 checksum How to use checksums |
22fee1d4afad7708cc6d8aad0892fdf5d87d050f0e3dac034b2e1fcd8060d18e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.4
|
Release files / gradio_simpletextextractfrompdf-0.0.4-py3-none-any.whl
| Download URL | gradio_simpletextextractfrompdf-0.0.4-py3-none-any.whl |
|---|---|
| Size | 2.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ec82ff0778abee2a538831a2dbdcca6bd220f2ee69368c23880524eb16b042ce
|
|
BLAKE2b-256 checksum How to use checksums |
93db3b7ce886f790fdd0fc9a1b303449607a7ff34aa96af85316cbdf0f54ed04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.4
|