oe-python-template 0.1.3__tar.gz → 0.2.0__tar.gz

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.1.1
+_commit: v0.1.4
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/.devcontainer/devcontainer.json

@@ -29,6 +29,7 @@
 				"gruntfuggly.todo-tree",
 		        "joshrmosier.streamlit-runner",
 				"kaih2o.python-resource-monitor",
+		        "marimo-team.vscode-marimo",
 				"mikestead.dotenv",
 				"ms-azuretools.vscode-docker",
 				"ms-python.debugpy",

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/.secrets.baseline

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-02T09:27:40Z"
+  "generated_at": "2025-03-02T18:16:03Z"
 }

{oe_python_template-0.1.3/template → oe_python_template-0.2.0}/.vscode/extensions.json

@@ -11,6 +11,7 @@
         "gruntfuggly.todo-tree",
         "joshrmosier.streamlit-runner",
         "kaih2o.python-resource-monitor",
+        "marimo-team.vscode-marimo",
         "mikestead.dotenv",
         "ms-azuretools.vscode-docker",
         "ms-python.debugpy",

oe_python_template-0.1.3/RELEASE_NOTES.md → oe_python_template-0.2.0/CHANGELOG.md

@@ -1,4 +1,18 @@
-[🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
+[🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
+
+## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..0.2.0) - 2025-03-02
+
+### 📚 Documentation
+
+- Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
+
+
+## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
+
+### ⛰️  Features
+
+- *(notebooks)* Introduce marimo - ([5d8eb68](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5d8eb687da96d5111130f67079cc8cbee06ca20e))
+
 
 ## [0.1.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.2..v0.1.3) - 2025-03-02
 

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/CONTRIBUTING.md

@@ -42,7 +42,8 @@ tests/                   # Unit and E2E tests
 └── fixtures/            # Fixtures and mock data
 examples/                # Example code demonstrating use of the project
 ├── streamlit.py         # Streamlit App, deployed in Streamlit Community Cloud
-├── jupyter.ipynb        # Jupyter notebook
+├── notebook.py          # Marimo notebook
+├── notebook.ipynb       # Jupyter notebook
 └── script.py            # Minimal script
 ```
 

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.1.3
+Version: 0.2.0
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
-Project-URL: Homepage, https://oe-python-template.readthedocs.io/
-Project-URL: Documentation, https://oe-python-template.readthedocs.io/
+Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
+Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Source, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
 Project-URL: Changelog, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases
 Project-URL: Issues, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues
@@ -63,7 +63,7 @@ Description-Content-Type: text/markdown
 ](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
-[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/)
+[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/en/latest/)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
@@ -128,7 +128,7 @@ uvx oe-python-template command --help      # all options for command
 * Various Examples:
   - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
 * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -172,9 +172,11 @@ uv sync --all-extras                                # Install streamlit dependen
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
 ```
 
-## Jupyter Notebook
+## Notebooks
 
-[Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+### Jupyter
+
+[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
 
 ... or run within VSCode
 
@@ -183,7 +185,31 @@ uv sync --all-extras                                # Install ipykernel dependen
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
-Click on `examples/jupyter.ipynb` in VSCode and run it.
+Click on `examples/notebook.ipynb` in VSCode and run it.
+
+### Marimo
+
+[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)
+
+Execute the notebook as a WASM based web app
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo run examples/notebook.py --watch      # Serve on localhost:2718, opens browser
+```
+
+or edit interactively in your browser
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, opens browser
+```
+
+... or edit interactively within VSCode
+
+Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/README.md

@@ -4,7 +4,7 @@
 ](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
-[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/)
+[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/en/latest/)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
@@ -69,7 +69,7 @@ uvx oe-python-template command --help      # all options for command
 * Various Examples:
   - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
 * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -113,9 +113,11 @@ uv sync --all-extras                                # Install streamlit dependen
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
 ```
 
-## Jupyter Notebook
+## Notebooks
 
-[Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+### Jupyter
+
+[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
 
 ... or run within VSCode
 
@@ -124,7 +126,31 @@ uv sync --all-extras                                # Install ipykernel dependen
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
-Click on `examples/jupyter.ipynb` in VSCode and run it.
+Click on `examples/notebook.ipynb` in VSCode and run it.
+
+### Marimo
+
+[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)
+
+Execute the notebook as a WASM based web app
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo run examples/notebook.py --watch      # Serve on localhost:2718, opens browser
+```
+
+or edit interactively in your browser
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, opens browser
+```
+
+... or edit interactively within VSCode
+
+Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 

oe_python_template-0.1.3/CHANGELOG.md → oe_python_template-0.2.0/RELEASE_NOTES.md

@@ -1,6 +1,20 @@
-[🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
+[🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.1.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.2..0.1.3) - 2025-03-02
+## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
+
+### 📚 Documentation
+
+- Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
+
+
+## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
+
+### ⛰️  Features
+
+- *(notebooks)* Introduce marimo - ([5d8eb68](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5d8eb687da96d5111130f67079cc8cbee06ca20e))
+
+
+## [0.1.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.2..v0.1.3) - 2025-03-02
 
 ### ⚙️ Miscellaneous Tasks
 

oe_python_template-0.2.0/SERVICE_CONNECTIONS.md

@@ -0,0 +1,62 @@
+# Setup service connections
+
+## Reporting code coverage via CodeCov (codecov.io)
+
+1. Sign-Up at https://app.codecov.io/
+2. Configure via https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen
+3. Copy value of `CODECOV_TOKEN` into your clipboard
+4. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
+5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
+
+## Analyzing code quality and security analysis via SonarQube cloud (sonarcloud.io)
+
+1. Sign-Up at https://sonarcloud.io
+2. Grant access to your new repo via https://github.com/settings/installations -> Configure
+3. Goto https://sonarcloud.io/projects/create and select the repo
+4. Select Previous Code when prompted
+5. Configure by going to https://sonarcloud.io/project/configuration?id=helmut-hoffer-von-ankershoffen_oe-python-template and clicking on "With GitHub Actions". Copy the value of `SONAR_TOKEN` into your clipboard.
+6. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `SONAR_TOKEN`, pasting the token from your clipboard as the value
+7. Goto https://sonarcloud.io/project/settings?id=helmut-hoffer-von-ankershoffen_oe-python-template and select "Quality Gate" in the left menu. Select "Sonar way" as default quality gate.
+8. Re-run the `CI / test` GitHub job in case you tried before and it failed as SonarQube was not yet wired up
+
+## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
+
+1. Sign-Up at https://readthed§cs.org/
+2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin oe-python-template in the search bar
+3. Select the repo and click Continue, then Next.
+4. On https://app.readthedocs.org/projects/oe-python-template/ wait for the build of the documentation to finish
+5. Goto https://oe-python-template.readthedocs.io/en/latest/
+
+## Publishing package to Python Package Index (pypi.org)
+
+1. Execute `uv run build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
+2. Sign-Up at https://pypi.org/
+3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it oe-python-template. Copy the value of the token into your clipboard.
+4. Execute `uv run publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
+5. Goto https://pypi.org/manage/account/ again and delete the previously created token oe-python-template of scope "Entire account".
+6. Now create an new API token, again called oe-python-template, but this time of scope "Project: oe-python-template". Copy the token into your clipboard.
+7. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and delete the previously created token.
+8. Then create a new repository secret called `UV_PUBLISH_TOKEN`, pasting the token from your clipboard as value
+9. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
+
+## Publishing Docker images to Docker Hub (docker.io)
+
+1. Sign-Up at https://hub.docker.com/
+2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
+3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
+4. Goto https://app.docker.com/settings/personal-access-tokens/create and create a new access token setting the description to oe-python-template, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
+5. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
+6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
+
+## Publishing Docker images to GitHub Container Registry (ghcr.io)
+
+1. This just works, no further setup required.
+2. Just `bump` to release and publish.
+
+## Streamlit app (streamlit.io)
+
+1. Sign-up at https://streamlit.io
+2. In settings connect your GitHub account
+3. Goto https://share.streamlit.io/new and click "Deploy a public app from GitHub"
+4. Select the oe-python-template repo, for "Main file path" select `examples/streamlit.py`, for App URL enter `oe-python-template`.streamlit.app. Click "Deploy"
+5. Goto https://oe-python-template.streamlit.app

oe_python_template-0.2.0/VERSION

@@ -0,0 +1 @@
+0.2.0

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/_readme_header.md

@@ -4,7 +4,7 @@
 ](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
-[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/)
+[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/en/latest/)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/_readme_main.md

@@ -38,7 +38,7 @@ uvx oe-python-template command --help      # all options for command
 * Various Examples:
   - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
 * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -82,9 +82,11 @@ uv sync --all-extras                                # Install streamlit dependen
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
 ```
 
-## Jupyter Notebook
+## Notebooks
 
-[Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
+### Jupyter
+
+[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
 
 ... or run within VSCode
 
@@ -93,7 +95,31 @@ uv sync --all-extras                                # Install ipykernel dependen
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
-Click on `examples/jupyter.ipynb` in VSCode and run it.
+Click on `examples/notebook.ipynb` in VSCode and run it.
+
+### Marimo
+
+[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)
+
+Execute the notebook as a WASM based web app
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo run examples/notebook.py --watch      # Serve on localhost:2718, opens browser
+```
+
+or edit interactively in your browser
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, opens browser
+```
+
+... or edit interactively within VSCode
+
+Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/copier.yml

@@ -34,11 +34,14 @@ project_name_snake_case_upper:
 project_description:
   type: str
   help: What does project {{ project_name }} do in one sentence?
-  placeholder: Python project complying with operational excellence practices.
+  placeholder: "Python project complying with operational excellence practices."
   validator: >-
-    {% if not project_description.strip() %}
-    Invalid project description
-    {% endif %}
+      {% if not project_description.strip() %}
+      Project description must not be empty.
+      {% endif %}
+      {% if not project_description.strip().endswith('.') %}
+      Project description must end with a dot.
+      {% endif %}
 
 author_name:
   type: str
@@ -190,12 +193,12 @@ streamlit_project_key:
 #    - application
 #    - shared library
 #  default: package
-# 
+#
 # python_version:
 #   type: str
 #   help: "{% if project_type == 'app' %}Which Python version should your app use?{% else %}What is the minimum Python version your package should support?{% endif %}"
 #   default: "{% if project_type == 'app' %}3.12{% else %}3.10{% endif %}"
-# 
+#
 # ci:
 #   type: str
 #   help: Which CI/CD provider would you like to use?
@@ -204,7 +207,7 @@ streamlit_project_key:
 #     GitLab CI/CD: gitlab
 #   default: "{% if 'github' in project_url %}github{% else %}gitlab{% endif %}"
 #   when: "{{ 'github' not in project_url and 'gitlab' not in project_url }}"
-# 
+#
 # typing:
 #   type: str
 #   help: Do you want to use optional or strict typing and linting?
@@ -212,18 +215,18 @@ streamlit_project_key:
 #     Optional: optional
 #     Strict: strict
 #   default: optional
-# 
+#
 # with_conventional_commits:
 #   type: bool
 #   help: Do you want to follow the Conventional Commits standard (https://www.conventionalcommits.org) for your commit messages?
 #   default: true
-# 
+#
 # with_fastapi_api:
 #   type: bool
 #   help: Does your app need a FastAPI API?
 #   default: false
 #   when: "{{ project_type == 'app' }}"
-# 
+#
 # with_typer_cli:
 #   type: bool
 #   help: Does your {{ project_type }} need a Typer CLI?

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/docs/source/conf.py

@@ -25,7 +25,7 @@ extensions = [
 project = "oe-python-template"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.1.3"
+version = "0.2.0"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

oe_python_template-0.2.0/examples/notebook.ipynb

@@ -0,0 +1,46 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Hello, world! The value of THE_VAR is not defined\n"
+     ]
+    }
+   ],
+   "source": [
+    "from oe_python_template import Service\n",
+    "\n",
+    "service = Service()\n",
+    "message = service.get_hello_world()\n",
+    "message"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

oe_python_template-0.2.0/examples/notebook.py

@@ -0,0 +1,18 @@
+import marimo
+
+__generated_with = "0.11.13"
+app = marimo.App()
+
+
+@app.cell
+def _():
+    from oe_python_template import Service
+
+    service = Service()
+    message = service.get_hello_world()
+    message
+    return Service, message, service
+
+
+if __name__ == "__main__":
+    app.run()

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/examples/streamlit.py

@@ -14,7 +14,7 @@ from oe_python_template import (
 
 sidebar = st.sidebar
 sidebar.write(
-    f" [OE Python Template v{__version__}](https://oe-python-template.readthedocs.io/)",
+    f" [OE Python Template v{__version__}](https://oe-python-template.readthedocs.io/en/latest/)",
 )
 sidebar.write("Built with love in Berlin 🐻")
 

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.1.3"
+version = "0.2.0"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -50,8 +50,8 @@ dependencies = [
 oe-python-template = "oe_python_template.cli:cli"
 
 [project.urls]
-Homepage = "https://oe-python-template.readthedocs.io/"
-Documentation = "https://oe-python-template.readthedocs.io/"
+Homepage = "https://oe-python-template.readthedocs.io/en/latest/"
+Documentation = "https://oe-python-template.readthedocs.io/en/latest/"
 Source = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template"
 Changelog = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases"
 Issues = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues"
@@ -104,7 +104,7 @@ target-version = "py311"
 preview = true
 fix = true
 line-length = 120
-exclude = [".fixme"]
+exclude = [".fixme","notebook.py"]
 
 
 [tool.ruff.lint]
@@ -156,6 +156,10 @@ ignore = [
 ]
 
 [tool.ruff.lint.extend-per-file-ignores]
+"examples/notebook.py" = [
+    # we are more relaxed in notebooks, while sill applying hundreds of rules
+    "B018",     # notebooks surface variable without print
+]
 
 [tool.ruff.format]
 docstring-code-format = true
@@ -189,7 +193,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.3"
+current_version = "0.2.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"
@@ -236,7 +240,7 @@ output = "CHANGELOG.md"
 render = true
 # template for the changelog header
 header = """
-[🧠 OE Python Template](https://oe-python-template.readthedocs.io/)\n
+[🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)\n
 """
 # template for the changelog body
 # https://keats.github.io/tera/docs/#introduction

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/sonar-project.properties

@@ -1,8 +1,8 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.3
+sonar.projectVersion=0.2.0
 sonar.projectDescription=OE Python Template
-sonar.links.homepage=https://oe-python-template.readthedocs.io
+sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
 sonar.links.ci=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions
 sonar.links.issues=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/template/.devcontainer/devcontainer.json.jinja

@@ -29,6 +29,7 @@
 				"gruntfuggly.todo-tree",
 		        "joshrmosier.streamlit-runner",
 				"kaih2o.python-resource-monitor",
+		        "marimo-team.vscode-marimo",
 				"mikestead.dotenv",
 				"ms-azuretools.vscode-docker",
 				"ms-python.debugpy",

{oe_python_template-0.1.3 → oe_python_template-0.2.0/template}/.vscode/extensions.json

@@ -11,6 +11,7 @@
         "gruntfuggly.todo-tree",
         "joshrmosier.streamlit-runner",
         "kaih2o.python-resource-monitor",
+        "marimo-team.vscode-marimo",
         "mikestead.dotenv",
         "ms-azuretools.vscode-docker",
         "ms-python.debugpy",

{oe_python_template-0.1.3 → oe_python_template-0.2.0}/template/CONTRIBUTING.md.jinja

@@ -42,7 +42,8 @@ tests/                   # Unit and E2E tests
 └── fixtures/            # Fixtures and mock data
 examples/                # Example code demonstrating use of the project
 ├── streamlit.py         # Streamlit App, deployed in Streamlit Community Cloud
-├── jupyter.ipynb        # Jupyter notebook
+├── notebook.py          # Marimo notebook
+├── notebook.ipynb       # Jupyter notebook
 └── script.py            # Minimal script
 ```
 

oe_python_template-0.2.0/template/README.md

@@ -0,0 +1 @@
+Will be generated from readme_*.md partials.