streamlit-file-explorer 0.1.0__tar.gz

streamlit_file_explorer-0.1.0/.streamlit/config.toml

@@ -0,0 +1,6 @@
+[theme]
+primaryColor = "#6777d8"
+baseRadius = "0.5rem"
+
+[browser]
+gatherUsageStats = false

streamlit_file_explorer-0.1.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.1.0 — 2026-10-27
+
+Initial implementation:
+
+- Finder-style Streamlit v2 component with locations, breadcrumbs, search, sorting and pagination.
+- File/folder selection, multiple selection, typed results and explicit confirmation.
+- Bounded text, table and raster-image previews; isolated theme-aware styling.
+- Root-scoped read-only access, symlink rejection, session-local state and cache.
+- Local demo, SLURM launcher and deployment documentation.
+- Wheels and source distributions with bundled frontend assets; Node-free pip installation.
+- Python/frontend tests, cross-platform CI and a Trusted Publishing release workflow.
+
+The public API is new and may change in 0.x releases. Changes will be documented here.

streamlit_file_explorer-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Start with a small issue describing the problem or a pull request with a focused change. For filesystem bugs, use synthetic files rather than private data. See README for supported platforms and known limits.
+
+## Set up
+
+Use Python 3.10+ and Node.js 24+:
+
+```bash
+uv sync --frozen
+npm --prefix streamlit_file_explorer/frontend ci
+uv run streamlit run streamlit_app.py --server.address 127.0.0.1
+```
+
+The production frontend bundle is committed so package users can install directly from source without Node. After editing TypeScript/CSS, run the frontend build and commit the changed bundle alongside source changes. The build cleans old hashed files. CI rebuilds and checks that committed assets are current.
+
+```bash
+npm --prefix streamlit_file_explorer/frontend run format
+npm --prefix streamlit_file_explorer/frontend test
+npm --prefix streamlit_file_explorer/frontend run build
+uv run ruff format .
+uv run ruff check .
+uv run mypy
+uv run pytest
+uv run python scripts/check_release.py
+uv build
+uv run python scripts/check_distribution.py
+uv run twine check --strict dist/*
+uv run python scripts/smoke_install.py
+```
+
+`smoke_install.py` creates a temporary environment, installs both artifacts using pip, and tests the installed code outside the checkout. It needs access to PyPI for dependencies. It also starts a real localhost Streamlit server and verifies the installed JS/CSS asset responses. Before a release, run `tests/apps/visual.py` for real-browser interaction checks in light/dark themes and narrow layouts.
+
+Preserve the separation between filesystem I/O, controller state, the Streamlit adapter and frontend presentation. Keep all file reads bounded, use the v2 component API, and never interpolate filenames or preview contents as HTML. Tests should exercise behavior, failures and regressions.
+
+See [the release guide](docs/releasing.md) for versioning and publishing.

streamlit_file_explorer-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

streamlit_file_explorer-0.1.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include LICENSE THIRD_PARTY_NOTICES.md README.md pyproject.toml uv.lock
+include build_support.py CHANGELOG.md CONTRIBUTING.md SECURITY.md
+include streamlit_app.py example.py
+include .streamlit/config.toml
+include examples/data/workspace/.example-hidden
+recursive-include scripts *.py
+recursive-include docs *.md
+recursive-include examples *.sbatch *.md *.txt *.csv *.tsv *.pdb *.yaml
+recursive-include tests *.py
+include streamlit_file_explorer/pyproject.toml streamlit_file_explorer/py.typed
+recursive-include streamlit_file_explorer/frontend/build *.js *.css
+recursive-include streamlit_file_explorer/frontend/src *.ts *.tsx *.css
+include streamlit_file_explorer/frontend/*.json streamlit_file_explorer/frontend/*.ts
+prune streamlit_file_explorer/frontend/node_modules
+prune tests/__pycache__

streamlit_file_explorer-0.1.0/PKG-INFO

@@ -0,0 +1,226 @@
+Metadata-Version: 2.4
+Name: streamlit-file-explorer
+Version: 0.1.0
+Summary: A Finder-style filesystem explorer for local and cluster Streamlit applications
+Author: Streamlit File Explorer contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/diliadis/streamlit-file-explorer
+Project-URL: Documentation, https://github.com/diliadis/streamlit-file-explorer#readme
+Project-URL: Repository, https://github.com/diliadis/streamlit-file-explorer
+Project-URL: Issues, https://github.com/diliadis/streamlit-file-explorer/issues
+Project-URL: Changelog, https://github.com/diliadis/streamlit-file-explorer/blob/main/CHANGELOG.md
+Keywords: streamlit,component,file-explorer,file-picker,slurm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: streamlit<2,>=1.53
+Dynamic: license-file
+
+# Streamlit File Explorer
+
+A reusable Finder-style file picker built with **Streamlit Custom Components v2**, React, and TypeScript. Browse explicitly configured directories on the machine running Streamlit: your laptop, a server, or a SLURM compute node with mounted project storage.
+
+Version **0.1.0** is the initial alpha release. Source: [diliadis/streamlit-file-explorer](https://github.com/diliadis/streamlit-file-explorer). It supports macOS and Linux. The public API may change in 0.x releases; a real SLURM deployment has not yet been validated.
+
+## What it does
+
+- Location sidebar, breadcrumbs, back/up navigation, and relative path entry.
+- Detailed sortable file list, debounced filename search, paging, and hidden-file toggle.
+- Optional previews for UTF-8 text, CSV/TSV, and small PNG/JPEG/GIF/WebP images.
+- File, folder, or mixed selection; optional multiple selection and suffix filters.
+- Explicit confirmation, returning typed `pathlib.Path` values to Python.
+- Streamlit theme colors, isolated CSS, responsive layout, keyboard controls, and instance-local state.
+- Read-only, shallow directory scans with bounded file reads and clear unavailable/partial states.
+
+There are no file mutations, uploads, downloads, recursive search, remote SSH browsing, or extra filesystem HTTP endpoints. A browser connected to a server browses **that server's filesystem**, not the browser user's laptop. Preview contents are sent to the browser.
+
+## Install
+
+Requires Python 3.10+ and Streamlit 1.53+. Installing the package does **not** require Node.js: the production frontend is included.
+
+Install from PyPI:
+
+```bash
+python -m pip install streamlit-file-explorer
+```
+
+Or install from this checkout:
+
+```bash
+python -m pip install .
+```
+
+Or install a built distribution:
+
+```bash
+python -m pip install dist/streamlit_file_explorer-0.1.0-py3-none-any.whl
+```
+
+Install the current development version directly from GitHub:
+
+```bash
+python -m pip install "git+https://github.com/diliadis/streamlit-file-explorer.git@main"
+```
+
+The GitHub install follows `main`; pin a commit for reproducibility. To pin the initial PyPI release, use `streamlit-file-explorer==0.1.0`.
+
+## Run the demo
+
+From this source checkout, after installing the package:
+
+```bash
+streamlit run streamlit_app.py --server.address 127.0.0.1
+```
+
+The demo defaults to bundled example files. To browse your own directories, configure named roots before starting it:
+
+```bash
+export FILE_EXPLORER_ROOTS='{"Projects":"/absolute/path/to/projects","Scratch":"/absolute/path/to/scratch"}'
+streamlit run streamlit_app.py --server.address 127.0.0.1
+```
+
+Use directories visible to the Streamlit process. Missing or unreadable roots produce a recoverable UI error. See the contributor guide for the uv/Node development workflow.
+
+## Use in your app
+
+Install the package using one of the available methods above. Use a unique, stable `key` for each explorer.
+
+```python
+from pathlib import Path
+import streamlit as st
+from streamlit_file_explorer import file_explorer
+
+
+# Replace /path/to/projects with a directory on the Streamlit host.
+@st.fragment
+def choose_input():
+    result = file_explorer(
+        {"Projects": Path("/path/to/projects")},
+        key="input_picker",
+        label="Choose input files",
+        extensions=[".csv", ".tsv"],
+        multiple=True,
+    )
+    if result.confirmed:
+        # Persist accepted values if other parts of your app need them later.
+        st.session_state["input_paths"] = result.selection
+    if st.session_state.get("input_paths"):
+        st.write([str(path) for path in st.session_state["input_paths"]])
+
+
+choose_input()
+```
+
+Keep result handling inside the fragment. Interactions then rerun only this section. If another part of the page must immediately react to confirmation, call `st.rerun()` after storing the accepted values. A fragment is optional: the component also works with ordinary app reruns. Do not place it inside `st.form`; the explorer requires immediate callbacks.
+
+`ExplorerResult` is immutable:
+
+| Field | Meaning |
+| --- | --- |
+| `directory: Path` | Current absolute directory on the Streamlit host. |
+| `selection: tuple[Path, ...]` | Highlighted items; highlighting a folder is allowed even in file mode. |
+| `selected_path: Path \| None` | Convenience property: the first selected path, or `None` when nothing is selected. |
+| `confirmed: bool` | True only on the run handling an explicit **Use selection** or **Use this folder** action. Only confirmed values satisfy the configured selection mode. |
+| `error: str \| None` | Recoverable navigation or selection error, also displayed in the component. |
+
+Selection is limited to the current folder and clears on navigation. Paths are revalidated at confirmation, but they are references, not open file handles: downstream code must handle files being moved, removed, or replaced later.
+
+### Parameters
+
+| Parameter | Default | Purpose |
+| --- | --- | --- |
+| `roots` | required | Mapping of visible location labels to directory paths. |
+| `key` | required | Stable, unique Streamlit component key. |
+| `label` | `"Files"` | Component heading and accessible name. |
+| `environment_label` | `""` | Optional host/location caption. |
+| `selection_mode` | `"file"` | `"file"`, `"directory"`, or `"any"`. |
+| `multiple` | `False` | Enable selection of up to 1,000 items in one directory. |
+| `extensions` | `None` | Case-insensitive suffixes such as `[".csv", ".tar.gz"]`; folders remain visible. |
+| `show_hidden` | `False` | Initial dotfile visibility; user can toggle it. |
+| `preview` | `True` | Initial preview-pane visibility; user can toggle it. |
+| `height` | `420` | File-list height in pixels, 240–500. Toolbar/footer add height; narrow layouts adjust the list. |
+| `page_size` | `100` | Rows sent to the frontend at once, 1–500. |
+| `max_entries` | `10_000` | Entries examined per directory, 1–100,000. Includes hidden entries. |
+| `max_preview_bytes` | `262_144` | File bytes read per preview, 1,024–2,097,152, plus one byte to detect truncation. |
+| `cache_ttl` | `2.0` | Session-local listing lifetime in seconds, 0–60. Refresh bypasses it. |
+
+Changing roots or filesystem/selection settings resets that instance's navigation. Changing its label, caption, or height preserves navigation. UI state persists through reruns in the same Streamlit session; it is not stored across new sessions or server restarts.
+
+### Interaction
+
+- Click a row to highlight it; double-click a folder, use its chevron, or press Enter to open it.
+- With multiple selection enabled, use checkboxes or Cmd/Ctrl-click to add/remove items.
+- Arrow Up/Down, Home, and End move focus between rows. Space highlights the focused row. Arrow Right opens a folder; Arrow Left goes to its parent.
+- Cmd/Ctrl-F within the component focuses search. Search matches names in the current scanned folder, not file contents or subdirectories.
+- Enter a **relative** path using the path button; an empty path opens the configured root.
+
+## Local and cluster behavior
+
+The same Python filesystem adapter runs locally and on a compute node. SLURM supplies an allocation; it is not a filesystem protocol. There is no cluster credential handling in the component. See [the SLURM guide](https://github.com/diliadis/streamlit-file-explorer/blob/main/docs/slurm.md) and [example batch script](https://github.com/diliadis/streamlit-file-explorer/blob/main/examples/launch_slurm.sbatch).
+
+Only the current folder is scanned. A short per-session cache reduces repeated metadata operations, and only the current page reaches React. The `max_entries` cap is a **scan limit**, not a directory-wide index: when hit, the UI warns that sorting and search operate on a partial listing. Which entries are scanned first depends on filesystem enumeration order. Raise the limit deliberately or choose a narrower root for large directories.
+
+Preview limits are independent: text uses at most 200 lines / 20,000 characters; CSV/TSV uses one header plus 50 data rows, 20 columns, and 300 characters per cell. Large images receive a metadata-only preview. Other binary formats are not decoded. Markup, filenames, and table values are rendered as text.
+
+Filesystem calls are synchronous. An unresponsive NFS/Lustre mount can still stall a session despite bounded entry counts; there is no hard I/O timeout. The loading state exposes this, but cannot cancel a blocked kernel read.
+
+## Access model
+
+- The Streamlit process's OS identity determines access. Configure roots in trusted application code; do not accept root paths directly from an untrusted browser.
+- On macOS/Linux, traversal uses directory descriptors and `O_NOFOLLOW`. Child symlinks are visible but cannot be opened, including links within the same root. Expose a desired target as its own configured root instead.
+- Roots and their ancestors must be trusted, deployment-controlled directories. OS permissions and your deployment remain the security boundary; the picker does not create filesystem isolation or per-user Unix identities.
+- Hidden-file visibility, suffix filters, and the preview toggle are UI features, not confidentiality controls. Everyone able to access an app instance may browse its configured roots with that process's permissions. A shared service account does not inherit each browser user's permissions.
+- A returned `Path` can change after selection. Apply your app's own access policy and validation when consuming it. Do not use this component as authorization for destructive downstream operations.
+- No root directory is registered as a Streamlit static asset directory. The component serves only its own bundled JS/CSS through the v2 asset manifest.
+- Windows is not a supported target in this release; its path-opening semantics have not been validated.
+
+## Development and release checks
+
+Contributors need Node.js 24+ and [uv](https://docs.astral.sh/uv/). Start with `uv sync --frozen` and `npm --prefix streamlit_file_explorer/frontend ci`.
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+npm --prefix streamlit_file_explorer/frontend test
+npm --prefix streamlit_file_explorer/frontend run format:check
+npm --prefix streamlit_file_explorer/frontend run build
+uv run python scripts/check_release.py
+uv build
+uv run python scripts/check_distribution.py
+uv run twine check --strict dist/*
+uv run python scripts/smoke_install.py
+```
+
+When changing frontend code, rebuild its assets and commit them **before** building a wheel or sdist. Otherwise, the checked-in production assets are ready to package. The build refuses to create a package if its assets are missing or ambiguous. The resulting wheel contains the compiled assets, component manifest, Python code, and typing marker. Install that wheel into another app environment with `pip install /path/to/streamlit_file_explorer-0.1.0-py3-none-any.whl`. The sdist also contains frontend source and its lockfile so assets can be rebuilt. CI is configured to run the checks on Linux and macOS, verify both artifacts, and install each with pip in a clean environment. The Actions tab reports the status of each pushed commit.
+
+For frontend iteration, run `npm --prefix streamlit_file_explorer/frontend run dev` in a second terminal. It rebuilds assets in watch mode. Restart the Streamlit process and reload the browser after a rebuild: registered asset paths can otherwise retain the previous bundle name. No Vite development server is exposed to users.
+
+### Structure
+
+- `filesystem.py`: bounded read-only I/O and path validation, independent of UI state.
+- `controller.py`: validated actions, navigation, selection, sorting, pagination, and per-instance listing cache.
+- `component.py`: public typed API, configuration checks, Streamlit callbacks and session state.
+- `frontend/src/`: typed React UI, scoped styles and previews.
+- `tests/`: filesystem, controller, and Streamlit adapter regression tests.
+- `streamlit_app.py`: runnable demo with sample data and a fragment.
+
+The template comes from Streamlit's [official v2 React/TypeScript starter](https://github.com/streamlit/component-template/tree/465144fa6764ac1227f299e222ef492262ed70c9/cookiecutter/v2). Component registration follows the [official v2 API](https://docs.streamlit.io/develop/api-reference/custom-components/st.components.v2.component). The interaction concept was inspired by [streamlit-file-browser](https://github.com/pragmatic-streamlit/streamlit-file-browser); this implementation does not depend on or copy that package's code.
+
+Licensed under Apache-2.0. See [LICENSE](https://github.com/diliadis/streamlit-file-explorer/blob/main/LICENSE).
+
+See the [contributor guide](https://github.com/diliadis/streamlit-file-explorer/blob/main/CONTRIBUTING.md), [changelog](https://github.com/diliadis/streamlit-file-explorer/blob/main/CHANGELOG.md), [release guide](https://github.com/diliadis/streamlit-file-explorer/blob/main/docs/releasing.md), and [security policy](https://github.com/diliadis/streamlit-file-explorer/blob/main/SECURITY.md).