streamlit-pdf 1.0.5__py3-none-any.whl

streamlit_pdf/__init__.py

@@ -0,0 +1,170 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import streamlit.components.v1 as components
+import streamlit as st
+import io
+from pathlib import Path
+from typing import Union, Optional, Dict, Any
+
+
+# Create a _RELEASE constant. We'll set this to False while we're developing
+# the component, and True when we're ready to package and distribute it.
+# (This is, of course, optional - there are innumerable ways to manage your
+# release process.)
+_DEV = os.environ.get("DEV", False)
+_RELEASE = not _DEV
+
+# Declare a Streamlit component for PDF viewing
+if not _RELEASE:
+    _component_func = components.declare_component(
+        "pdf_viewer",
+        url="http://localhost:3001",
+    )
+else:
+    # When we're distributing a production version of the component, we'll
+    # replace the `url` param with `path`, and point it to the component's
+    # build directory:
+    parent_dir = os.path.dirname(os.path.abspath(__file__))
+    build_dir = os.path.join(parent_dir, "frontend/build")
+
+    _component_func = components.declare_component("pdf_viewer", path=build_dir)
+
+
+def pdf_viewer(
+    file: Union[str, bytes, Path, io.BytesIO, io.RawIOBase, io.BufferedReader],
+    height: int = 600,
+    key: Optional[str] = None,
+) -> Optional[Dict[str, Any]]:
+    """Create a new instance of the PDF viewer component.
+
+
+    Parameters
+    ----------
+    file : str, bytes, Path, io.BytesIO, io.RawIOBase, or io.BufferedReader
+        The PDF file to display. This can be:
+        - A URL to a PDF file (e.g., "https://example.com/document.pdf")
+        - A local file path (e.g., "./documents/sample.pdf")
+        - Raw bytes of a PDF file
+        - A pathlib.Path object pointing to a PDF file
+        - A BytesIO object containing PDF data
+        - A file-like object containing PDF data
+        - Base64 encoded PDF data URI
+    height : int, optional
+        The height of the PDF viewer in pixels. Default is 600.
+    key : str or None, optional
+        An optional key that uniquely identifies this component. If this is
+        None, and the component's arguments are changed, the component will
+        be re-mounted in the Streamlit frontend and lose its current state.
+
+    Returns
+    -------
+    None
+
+    Examples
+    --------
+    Basic usage with a URL:
+    >>> pdf_viewer("https://example.com/document.pdf")
+
+    With custom height:
+    >>> pdf_viewer(
+    ...     file="./documents/report.pdf",
+    ...     height=1000
+    ... )
+
+    Loading from bytes:
+    >>> with open("document.pdf", "rb") as f:
+    ...     pdf_bytes = f.read()
+    >>> pdf_viewer(pdf_bytes)
+
+    Loading from a Path object:
+    >>> from pathlib import Path
+    >>> pdf_viewer(Path("./documents/report.pdf"))
+
+    Loading from a BytesIO object:
+    >>> import io
+    >>> with open("document.pdf", "rb") as f:
+    ...     pdf_buffer = io.BytesIO(f.read())
+    >>> pdf_viewer(pdf_buffer)
+    """
+
+    # Process the file parameter
+    processed_file = _process_file_input(file)
+
+    # Call the component function with processed arguments
+    component_value = _component_func(
+        file=processed_file, height=height, key=key, default=None
+    )
+
+    return component_value
+
+
+def _process_file_input(
+    file: Union[str, bytes, Path, io.BytesIO, io.RawIOBase, io.BufferedReader],
+) -> str:
+    """Process different types of file inputs into a format the frontend can handle.
+
+    Parameters
+    ----------
+    file : str, bytes, Path, io.BytesIO, io.RawIOBase, or io.BufferedReader
+        The input file in various formats
+
+    Returns
+    -------
+    str
+        A URL that the frontend can use to load the PDF
+    """
+    # Handle empty string case - return empty string to let frontend handle it
+    if isinstance(file, str) and not file:
+        return ""
+
+    if isinstance(file, str) and (
+        file.startswith(("http://", "https://", "data:application/pdf"))
+    ):
+        # For URLs and data URIs, use them directly
+        return file
+    else:
+        # For local files or raw data, process and store in media file manager
+        coordinates = st._main._get_delta_path_str()
+
+        # Convert data to appropriate format
+        data_or_filename: Union[bytes, str, None]
+        if isinstance(file, (str, bytes)):
+            # Pass strings and bytes through unchanged
+            data_or_filename = file
+        elif isinstance(file, Path):
+            data_or_filename = str(file)
+        elif isinstance(file, io.BytesIO):
+            file.seek(0)
+            data_or_filename = file.getvalue()
+        elif isinstance(file, (io.RawIOBase, io.BufferedReader)):
+            file.seek(0)
+            data_or_filename = file.read()
+        else:
+            data_or_filename = None
+
+        if data_or_filename is None:
+            raise RuntimeError(f"Cannot process provided data of type: {type(file)}")
+
+        # Add to media file manager
+        from streamlit.runtime import Runtime
+
+        runtime = Runtime.instance()
+        pdf_url = runtime.media_file_mgr.add(
+            data_or_filename, "application/pdf", coordinates
+        )
+
+        return pdf_url

streamlit_pdf/frontend/build/.gitignore

@@ -0,0 +1,5 @@
+# PDF.js Assets (copied from node_modules/pdfjs-dist at build time)
+workers/
+cmaps/
+standard_fonts/
+

streamlit_pdf/frontend/build/assets/index-C1nTKtnz.css

@@ -0,0 +1 @@
+._container_b38l5_18{width:100%;overflow:hidden;background-color:var(--background-color);position:relative}._content_b38l5_25{background-color:var(--secondary-background-color);overflow:auto;padding:0;position:relative;border-radius:8px}._noFileContainer_b38l5_33{display:flex;align-items:center;justify-content:center;padding:32px;background-color:var(--secondary-background-color);border:2px dashed rgba(0,0,0,.2);border-radius:8px;text-align:center}._noFileIcon_b38l5_44{font-size:48px;margin:0 auto 16px;display:block}._noFileTitle_b38l5_50{margin-top:8px;font-size:14px;font-weight:500;color:var(--text-color)}._noFileText_b38l5_57{margin-top:4px;font-size:14px;color:var(--text-color-secondary)}._loadingContainer_b38l5_63{display:flex;align-items:center;justify-content:center;padding:32px}._loadingContent_b38l5_70{text-align:center}._spinner_b38l5_74{border:2px solid var(--secondary-background-color);border-top:2px solid var(--primary-color);border-radius:50%;width:32px;height:32px;animation:_spin_b38l5_74 1s linear infinite;margin:0 auto}@keyframes _spin_b38l5_74{0%{transform:rotate(0)}to{transform:rotate(360deg)}}._loadingText_b38l5_89{margin-top:12px;font-size:14px;color:var(--text-color-secondary)}._errorContainer_b38l5_95{display:flex;align-items:center;justify-content:center;padding:32px;text-align:center}._errorIcon_b38l5_103{font-size:48px;margin:0 auto 16px;display:block}._errorTitle_b38l5_109{margin-top:8px;font-size:16px;font-weight:500;color:var(--text-color)}._errorText_b38l5_116{margin-top:4px;font-size:14px;color:var(--text-color-secondary)}._documentContainer_b38l5_122{width:100%;box-sizing:border-box;position:relative;padding-top:12px}._virtualContainer_b38l5_129{width:100%;position:relative}._virtualItem_b38l5_134{position:absolute;top:0;height:auto;padding-bottom:12px}._pageContainer_b38l5_141{display:block;background-color:var(--background-color);box-shadow:0 1px 3px #0000001a;border-radius:4px;overflow:visible;margin:0}._pdfPage_b38l5_150{display:block}._pdfPage_b38l5_150 canvas{display:block}._pagePlaceholder_b38l5_158{display:flex;align-items:center;justify-content:center;height:var(--default-page-height, 800px);background-color:var(--secondary-background-color);border:1px solid rgba(0,0,0,.1);color:var(--text-color-secondary);font-size:14px}._zoomControls_b38l5_170{display:flex;flex-direction:column;align-items:center;gap:0px;position:absolute;top:0;right:0;margin:.625rem .625rem 0 0;z-index:10;background-color:var(--background-color);border:none;border-radius:4px;box-shadow:0 0 0 2px #0000001a;transition:opacity .2s ease;opacity:0;padding:0;overflow:hidden}._zoomControls_b38l5_170._visible_b38l5_190{opacity:1;visibility:visible}._zoomButton_b38l5_195{background-color:transparent;color:var(--text-color);border:none;border-radius:0;width:29px;height:29px;display:flex;align-items:center;justify-content:center;cursor:pointer;font-size:16px;font-family:Source Sans,sans-serif;-webkit-user-select:none;user-select:none;padding:0;outline:none;box-sizing:border-box;position:relative}._zoomButton_b38l5_195 svg{display:block;width:100%;height:100%}._zoomButton_b38l5_195+._zoomButton_b38l5_195{border-top:1px solid rgba(128,128,128,.2)}._zoomButton_b38l5_195:first-child{border-top-left-radius:4px;border-top-right-radius:4px}._zoomButton_b38l5_195:last-child{border-bottom-left-radius:4px;border-bottom-right-radius:4px}._zoomButton_b38l5_195:hover:not(._disabled_b38l5_237){background-color:#0000000d}._zoomButton_b38l5_195:focus{box-shadow:0 0 2px 2px #0096ff}._zoomButton_b38l5_195:focus:not(:focus-visible){box-shadow:none}._zoomButton_b38l5_195._disabled_b38l5_237{cursor:not-allowed}._zoomButton_b38l5_195._disabled_b38l5_237 svg{opacity:.25}body{margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}