tesseract-streamlit 0.1.0__tar.gz

tesseract_streamlit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025- Pasteur Labs
+
+   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.

tesseract_streamlit-0.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+# Include all files here that should be part of source distributions
+include requirements.txt
+include README.md
+
+# Include Cython source files, and exclude generated C files
+# (required to build Cython extensions during wheel creation)
+recursive-include tesseract_streamlit *.pyx *.pxd
+recursive-exclude tesseract_streamlit *.c
+
+# Include Jinja templates
+recursive-include tesseract_streamlit/templates *.j2
+recursive-include tesseract_streamlit/resources *.ico

tesseract_streamlit-0.1.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: tesseract-streamlit
+Version: 0.1.0
+Summary: Tesseract Streamlit automatically generates Streamlit apps from Tesseract APIs.
+Author-email: "The tesseract-streamlit team @ Pasteur Labs" <info@simulation.science>
+Project-URL: Homepage, https://github.com/pasteurlabs/tesseract-streamlit
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: streamlit
+Requires-Dist: tesseract-core
+Requires-Dist: jinja2
+Requires-Dist: numpy
+Requires-Dist: pyvista[jupyter]
+Requires-Dist: stpyvista
+Requires-Dist: typing-extensions
+Requires-Dist: requests
+Requires-Dist: click
+Requires-Dist: orjson
+Requires-Dist: platformdirs
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: typeguard; extra == "dev"
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: tesseract-streamlit[docs]; extra == "dev"
+Dynamic: license-file
+
+# Tesseract Streamlit
+
+A CLI tool that generates a Streamlit app from a running [Tesseract](https://github.com/pasteurlabs/tesseract-core) instance.
+The generated app allows users to interactively submit input to the `apply` endpoint and optionally visualise results using custom plotting functions.
+
+## ✨ Features
+
+* 🔍 Parses Tesseract's OpenAPI schema
+* ⚙️ Automatically builds input forms for the `apply` endpoint
+* 📊 Supports user-defined plotting of inputs and outputs
+* 🚀 Outputs a ready-to-run Streamlit app script
+* 🧩 Modular and customizable with minimal boilerplate
+
+## 🛠 Requirements
+
+- Modern UNIX based OS (Linux or macOS), or Windows with WSL
+- Python >= 3.10
+- [tesseract-core][tesscore]
+
+## 📦 Installation
+
+```bash
+pip install tesseract-streamlit
+```
+
+## 🧰 Usage
+
+```bash
+tesseract-streamlit [OPTIONS] URL OUTPUT
+```
+
+* `URL`: The address to the Tesseract instance you want to interface with.
+* `OUTPUT`: The file path to write the generated Streamlit app.
+
+### ⚙️ Options
+
+| Option                 | Description                                                        |
+| ---------------------- | ------------------------------------------------------------------ |
+| `--user-code, -u`      | (Optional) Path to Python file with plotting functions             |
+| `--help`               | Show the help message and exit                                     |
+
+### 📊 With Custom Plotting
+
+You can optionally pass a Python file containing user-defined functions for plotting inputs and/or outputs.
+
+```bash
+tesseract-streamlit --user-code udf.py http://localhost:48819 app.py
+```
+
+The `udf.py` file should define functions like:
+
+```python
+import plotly.graph_objects as go
+
+def plot(inputs, outputs) -> go.Figure:
+    """Title of the plot.
+
+    Description of what the plot conveys. Will be displayed above the
+    plot itself.
+    """
+    fig = go.Figure()
+    # some plotly logic to visualise input_schema and output_schema
+    return fig
+```
+
+Where we have chosen Plotly as our plotting back-end, but [any supported library by Streamlit is allowed][stplots].
+
+> [!NOTE]
+> Additionally, we support PyVista plots (thanks to [edsaac/stpyvista](https://github.com/edsaac/stpyvista))!
+> Just annotate your function to return a `pyvista.Plotter` instance, and an interactive plot will be inserted.
+
+<details>
+<summary>⚙️ More info on defining custom plotting functions</summary>
+<br />
+
+Custom plotting is easy and flexible. Here’s how to make the most of it:
+
+
+- Function names don't matter, so name them however you like.
+- Define multiple functions to visualise more than one aspect of the data. Each one will generate a separate plot in the Streamlit app.
+- Add a docstring to each function to add descriptive text in the app:
+    - **First line** of the docstring will appear as the **plot title**.
+    - Remaining lines will be shown as a **description** below the title.
+    - Omitting docstrings is allowed, but raises a `UserDefinedFunctionWarning`.
+- Public functions must include either `inputs`, `outputs`, or both as parameter names. Any public function that doesn't use these names will raise a `UserDefinedFunctionError`.
+- Private functions may be defined with a leading underscore in their name, *eg.* `def _foo(x: float) -> float: ...`.
+    - Arbitrary parameters and return types are allowed.
+    - Will not produce plots directly in the Web UI.
+    - Can be called from within your public plotting functions.
+
+
+This setup gives you control over what to display and how to explain it, directly from your code.
+</details>
+
+## 📁 Example
+
+See the example README for a basic example walk-through, or simply run the following script to see the end result!
+
+```bash
+bash examples/vectoradd_jax/run.sh
+```
+
+This will open a browser window with the Streamlit UI where users can input values and visualise the response.
+
+| ![](examples/vectoradd_jax/screenshots/header-vec-a.png) | ![](examples/vectoradd_jax/screenshots/outputs.png) |
+| --------------------------------- | ---------------------------- |
+| ![](examples/vectoradd_jax/screenshots/vec-b.png)        | ![](examples/vectoradd_jax/screenshots/plot.png)    |
+
+## ⚠️ Current Limitations
+
+While `tesseract-streamlit` supports Tesseracts with an `InputSchema` formed with arbitrary nesting of Pydantic models, it **does not yet support** nesting Pydantic models **inside native Python collection types** such as:
+
+- ❌ `list[Model]`
+- ❌ `tuple[Model, ...]`
+- ❌ `dict[str, Model]`
+
+These types will raise an error or be ignored in the generated app.
+
+You **can** however use these native collections with basic Python types, such as:
+
+- ✅ `list[str]`
+- ✅ `dict[str, int]`
+- ✅ `tuple[float, float]`
+
+If you would like to request support for nested models within collections in a future release, please let us know.
+
+[stplots]: https://docs.streamlit.io/develop/api-reference/charts#advanced-chart-elements
+[tesscore]: https://github.com/pasteurlabs/tesseract-core

tesseract_streamlit-0.1.0/README.md

@@ -0,0 +1,128 @@
+# Tesseract Streamlit
+
+A CLI tool that generates a Streamlit app from a running [Tesseract](https://github.com/pasteurlabs/tesseract-core) instance.
+The generated app allows users to interactively submit input to the `apply` endpoint and optionally visualise results using custom plotting functions.
+
+## ✨ Features
+
+* 🔍 Parses Tesseract's OpenAPI schema
+* ⚙️ Automatically builds input forms for the `apply` endpoint
+* 📊 Supports user-defined plotting of inputs and outputs
+* 🚀 Outputs a ready-to-run Streamlit app script
+* 🧩 Modular and customizable with minimal boilerplate
+
+## 🛠 Requirements
+
+- Modern UNIX based OS (Linux or macOS), or Windows with WSL
+- Python >= 3.10
+- [tesseract-core][tesscore]
+
+## 📦 Installation
+
+```bash
+pip install tesseract-streamlit
+```
+
+## 🧰 Usage
+
+```bash
+tesseract-streamlit [OPTIONS] URL OUTPUT
+```
+
+* `URL`: The address to the Tesseract instance you want to interface with.
+* `OUTPUT`: The file path to write the generated Streamlit app.
+
+### ⚙️ Options
+
+| Option                 | Description                                                        |
+| ---------------------- | ------------------------------------------------------------------ |
+| `--user-code, -u`      | (Optional) Path to Python file with plotting functions             |
+| `--help`               | Show the help message and exit                                     |
+
+### 📊 With Custom Plotting
+
+You can optionally pass a Python file containing user-defined functions for plotting inputs and/or outputs.
+
+```bash
+tesseract-streamlit --user-code udf.py http://localhost:48819 app.py
+```
+
+The `udf.py` file should define functions like:
+
+```python
+import plotly.graph_objects as go
+
+def plot(inputs, outputs) -> go.Figure:
+    """Title of the plot.
+
+    Description of what the plot conveys. Will be displayed above the
+    plot itself.
+    """
+    fig = go.Figure()
+    # some plotly logic to visualise input_schema and output_schema
+    return fig
+```
+
+Where we have chosen Plotly as our plotting back-end, but [any supported library by Streamlit is allowed][stplots].
+
+> [!NOTE]
+> Additionally, we support PyVista plots (thanks to [edsaac/stpyvista](https://github.com/edsaac/stpyvista))!
+> Just annotate your function to return a `pyvista.Plotter` instance, and an interactive plot will be inserted.
+
+<details>
+<summary>⚙️ More info on defining custom plotting functions</summary>
+<br />
+
+Custom plotting is easy and flexible. Here’s how to make the most of it:
+
+
+- Function names don't matter, so name them however you like.
+- Define multiple functions to visualise more than one aspect of the data. Each one will generate a separate plot in the Streamlit app.
+- Add a docstring to each function to add descriptive text in the app:
+    - **First line** of the docstring will appear as the **plot title**.
+    - Remaining lines will be shown as a **description** below the title.
+    - Omitting docstrings is allowed, but raises a `UserDefinedFunctionWarning`.
+- Public functions must include either `inputs`, `outputs`, or both as parameter names. Any public function that doesn't use these names will raise a `UserDefinedFunctionError`.
+- Private functions may be defined with a leading underscore in their name, *eg.* `def _foo(x: float) -> float: ...`.
+    - Arbitrary parameters and return types are allowed.
+    - Will not produce plots directly in the Web UI.
+    - Can be called from within your public plotting functions.
+
+
+This setup gives you control over what to display and how to explain it, directly from your code.
+</details>
+
+## 📁 Example
+
+See the example README for a basic example walk-through, or simply run the following script to see the end result!
+
+```bash
+bash examples/vectoradd_jax/run.sh
+```
+
+This will open a browser window with the Streamlit UI where users can input values and visualise the response.
+
+| ![](examples/vectoradd_jax/screenshots/header-vec-a.png) | ![](examples/vectoradd_jax/screenshots/outputs.png) |
+| --------------------------------- | ---------------------------- |
+| ![](examples/vectoradd_jax/screenshots/vec-b.png)        | ![](examples/vectoradd_jax/screenshots/plot.png)    |
+
+## ⚠️ Current Limitations
+
+While `tesseract-streamlit` supports Tesseracts with an `InputSchema` formed with arbitrary nesting of Pydantic models, it **does not yet support** nesting Pydantic models **inside native Python collection types** such as:
+
+- ❌ `list[Model]`
+- ❌ `tuple[Model, ...]`
+- ❌ `dict[str, Model]`
+
+These types will raise an error or be ignored in the generated app.
+
+You **can** however use these native collections with basic Python types, such as:
+
+- ✅ `list[str]`
+- ✅ `dict[str, int]`
+- ✅ `tuple[float, float]`
+
+If you would like to request support for nested models within collections in a future release, please let us know.
+
+[stplots]: https://docs.streamlit.io/develop/api-reference/charts#advanced-chart-elements
+[tesscore]: https://github.com/pasteurlabs/tesseract-core

tesseract_streamlit-0.1.0/pyproject.toml

@@ -0,0 +1,98 @@
+[project]
+name = "tesseract-streamlit"
+# TODO: add a short description here (same as in GitHub UI)
+description = "Tesseract Streamlit automatically generates Streamlit apps from Tesseract APIs."
+readme = "README.md"
+authors = [
+    {name = "The tesseract-streamlit team @ Pasteur Labs", email = "info@simulation.science"},
+]
+requires-python = ">=3.10,<3.14"
+# TODO: add your dependencies here
+dependencies = [
+    "streamlit",
+    "tesseract-core",
+    "jinja2",
+    "numpy",
+    "pyvista[jupyter]",
+    "stpyvista",
+    "typing-extensions",
+    "requests",
+    "click",
+    "orjson",
+    "platformdirs",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/pasteurlabs/tesseract-streamlit"
+
+[project.scripts]
+tesseract-streamlit = "tesseract_streamlit.cli:cli"
+
+[project.optional-dependencies]
+docs = [
+    "sphinx",
+    "sphinx_autodoc_typehints",
+    "furo",
+    "myst-parser",
+]
+dev = [
+    "pre-commit",
+    "pytest",
+    "pytest-cov",
+    "typeguard",
+    "matplotlib",
+    "pyyaml",
+    "tesseract-streamlit[docs]",
+]
+
+[build-system]
+requires = ["setuptools", "versioneer[toml]==0.29"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["tesseract_streamlit", "tesseract_streamlit.*"]
+
+[tool.versioneer]
+VCS = "git"
+style = "pep440"
+versionfile_source = "tesseract_streamlit/_version.py"
+versionfile_build = "tesseract_streamlit/_version.py"
+tag_prefix = "v"
+parentdir_prefix = "tesseract_streamlit-"
+
+[tool.pytest.ini_options]
+# Test type hints via typeguard - disabled by default
+# addopts = ["--typeguard-packages=tesseract_streamlit"]
+testpaths = ["tests"]
+filterwarnings = [
+    "error",
+    # ignored by default
+    "ignore::DeprecationWarning",
+    "ignore::PendingDeprecationWarning",
+    "ignore::ImportWarning",
+    # raised by Cython, usually harmless
+    "ignore:numpy.dtype size changed",
+    "ignore:numpy.ufunc size changed",
+    # sometimes, dependencies leak resources
+    "ignore:.*socket\\.socket.*:pytest.PytestUnraisableExceptionWarning",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["tesseract_streamlit"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "pass",
+]
+ignore_errors = true
+omit = [
+    "tesseract_streamlit/_version.py",
+]