chore/docs: remove poetry.lock and other files

Improve docs

.gitignore

@@ -1,5 +1,12 @@
+# IDE files
+.idea
+.vscode
+
+# Python files
 __pycache__
 .ipynb_checkpoints
+
+# MacOS
 .DS_Store
 
 # Code coverage
@@ -9,7 +16,8 @@ lcov.info
 # Results of playwright tests with tracing
 test-results/
 
-# Files from playwright installed with npm
+# Files packages installed with npm (if you use it)
 node_modules
-package-lock.json
-package.json
+
+# Posit Connect deployment
+rsconnect-python

tapyr_template/settings.py

@@ -2,4 +2,11 @@
 
 
 class AppSettings(BaseSettings):
+    """
+    Placeholder for application settings.
+    Find more information about pydantic settings
+    like yaml/toml parameters, environmental variables at:
+    https://docs.pydantic.dev/latest/concepts/pydantic_settings/
+    """
+
     log_level: str = "INFO"

tapyr_template/view/root/server.py

@@ -4,6 +4,10 @@
 def server(input: Inputs, output: Outputs, session: Session):
     @render.ui
     def link_button():
+        """
+        UI link that looks like a button. This element could be placed directly in the UI definition
+        but is here to showcase testing.
+        """
         return ui.a(
             "Start with the docs!",
             href="https://appsilon.github.io/tapyr-docs/",

tests/conftest.py

@@ -1,3 +1,6 @@
+# conftest.py files are always executed in pytest
+# https://stackoverflow.com/questions/34466027/what-is-conftest-py-for-in-pytest
+
 from collections.abc import Generator
 
 import pytest

tests/playwirght/conftest.py

@@ -1,3 +1,4 @@
 from shiny.pytest import create_app_fixture
 
+# https://shiny.posit.co/py/docs/end-to-end-testing.html
 app = create_app_fixture("../../app.py")

tests/playwirght/test_ui.py

@@ -3,13 +3,17 @@
 from shiny.run import ShinyAppProc
 
 
-def test_startup2(page: Page, app: ShinyAppProc):
+def test_startup(page: Page, app: ShinyAppProc):
+    """
+    Tests if shiny apps has successfully started.
+    """
     page.goto(app.url)
 
     # Wait for the page to load fully
     page.wait_for_load_state("networkidle")
 
-    # Check if the `#shiny-disconnected-overlay` element is not present
+    # When shiny fails after startup, it adds the #shiny-disconnected-overlay div
+    # We check if it's not present in the page
     assert not page.query_selector("#shiny-disconnected-overlay"), "The shiny app failed to start"
 
 
@@ -20,5 +24,6 @@ def test_link_button(page: Page, app: ShinyAppProc):
     And probably you want to remove/adjust for your own needs.
     """
     page.goto(app.url)
+    # https://shiny.posit.co/py/docs/end-to-end-testing.html
     link_button = controller.OutputUi(page, "link_button")
     link_button.expect.to_contain_text("Start with the docs!")