lincc-frameworks · smcguire-cmu · Sep 11, 2025 · Sep 11, 2025 · Sep 11, 2025 · Sep 11, 2025
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -8,8 +8,7 @@ custom_install: true
 enforce_style:
 - ruff_lint
 - ruff_format
-failure_notification:
-- email
+failure_notification: []
 include_benchmarks: false
 include_docs: true
 include_notebooks: true
@@ -19,7 +18,6 @@ project_license: MIT
 project_name: jump-starter
 project_organization: lincc-frameworks
 python_versions:
-- '3.9'
 - '3.10'
 - '3.11'
 - '3.12'

diff --git a/.github/workflows/smoke-test.yml b/.github/workflows/smoke-test.yml
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4
@@ -39,37 +39,4 @@ jobs:
         pip list
     - name: Run unit tests with pytest
       run: |
-        python -m pytest
-    - name: Send status to author's email      
-      if: ${{ failure() }} && github.event_name != 'workflow_dispatch' }} # Only email if the workflow failed and was not manually started. Customize this as necessary.
-      uses: dawidd6/action-send-mail@v3
-      with:
-        # Required mail server address if not connection_url:
-        server_address: smtp.gmail.com
-        # Server port: (uses TLS by default if server_port is 465)
-        server_port: 465
-
-        # Mail server username:
-        username: ${{secrets.MAIL_USERNAME}}
-        # Mail server password:
-        password: ${{secrets.MAIL_PASSWORD}}
-        # Required recipients' addresses:
-        to: [email protected]
-
-        # Required mail subject:
-        subject: Smoke test ${{ job.status }} in ${{github.repository}}
-        # Required sender full name:
-        from: GitHub Actions Report
-        # Optional body:
-        html_body: |
-          <!DOCTYPE html>
-          <html>
-          <body>
-          <h3>Smoke test ${{ job.status }}</h3>
-          <p>The smoke test in <b>${{ github.repository }}</b> has completed with result: <b>${{ job.status }}</b></p>
-          <p><a href="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}">
-          ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
-          </a></p>
-          </body>
-          </html>
-
+        python -m pytest
diff --git a/.github/workflows/testing-and-coverage.yml b/.github/workflows/testing-and-coverage.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4
@@ -41,10 +41,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.9
+    - name: Set up Python 3.10
       uses: actions/setup-python@v5
       with:
-        python-version: '3.9'
+        python-version: '3.10'
     - name: Install dependencies
       run: |
         sudo apt-get update

diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/jump-starter.iml b/.idea/jump-starter.iml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/ruff.xml b/.idea/ruff.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 
-# jump-starter
+# JuMP-Starter
+
+The Jupyter Managed Project Starter allows you to create an interactive jupyter questionnaire to help users
+quickly get started with your package.
 
 [![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -15,8 +15,14 @@ classifiers = [
     "Programming Language :: Python",
 ]
 dynamic = ["version"]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
+    "ipywidgets>=8.0",
+    "pydantic>=2.0",
+    "pyyaml>=6.0",
+    "markdown>=3.4",
+    "pygments>=2.0",
+    "jinja2>=3.0"
 ]
 
 [project.urls]
@@ -30,7 +36,10 @@ dev = [
     "pre-commit", # Used to run checks before finalizing a git commit
     "pytest",
     "pytest-cov", # Used to report total code coverage
+    "pytest-mock", # Used to mock objects in tests
     "ruff", # Used for static linting of files
+    "types-Markdown", # Type information for markdown
+    "types-PyYAML", # Type information for pyyaml
 ]
 
 [build-system]
@@ -53,7 +62,7 @@ addopts = "--doctest-modules --doctest-glob=*.rst"
 
 [tool.ruff]
 line-length = 110
-target-version = "py39"
+target-version = "py310"
 [tool.ruff.lint]
 select = [
     # pycodestyle

diff --git a/src/jump_starter/__init__.py b/src/jump_starter/__init__.py
@@ -0,0 +1,3 @@
+from .questionnaire import QuestionnaireWidget
+
+__all__ = ["QuestionnaireWidget"]
diff --git a/src/jump_starter/models.py b/src/jump_starter/models.py
@@ -0,0 +1,74 @@
+from datetime import datetime
+from typing import Union
+
+from pydantic import BaseModel, Field
+
+
+class Template(BaseModel):
+    """Represents a template for code replacement in the questionnaire."""
+
+    replacement: str
+    code: str
+
+
+class Answer(BaseModel):
+    """Represents an answer to a question in the questionnaire."""
+
+    answer: str
+    tooltip: str = ""
+    templates: list[Template] = Field(default_factory=list)
+    followups: list[Union["Question", "Switch"]] = Field(default_factory=list)
+    commentary: str = ""
+
+
+class Question(BaseModel):
+    """Represents a question in the questionnaire."""
+
+    question: str
+    variable: str | None = None
+    answers: list[Answer]
+
+
+class Case(BaseModel):
+    """Represents a case in a switch statement within the questionnaire."""
+
+    value: int | None = None
+    questions: list[Union[Question, "Switch"]]
+
+
+class Switch(BaseModel):
+    """Represents a switch statement in the questionnaire."""
+
+    switch: str
+    cases: list[Case]
+
+
+# Rebuild models to support self-referencing types and forward references
+Question.model_rebuild()
+Answer.model_rebuild()
+Case.model_rebuild()
+Switch.model_rebuild()
+
+
+class QuestionAnswer(BaseModel):
+    """Represents a user's answer to a question."""
+
+    question: str
+    answer: str
+    value: int
+
+
+class QuestionAnswers(BaseModel):
+    """Represents a collection of user answers to questions."""
+
+    answers: list[QuestionAnswer] = Field(default_factory=list)
+    timestamp: datetime = Field(default_factory=datetime.now)
+
+
+class Questionnaire(BaseModel):
+    """Represents a questionnaire with an initial template and a list of questions."""
+
+    initial_template: str
+    initial_commentary: str = ""
+    feedback_url: str | None = None
+    questions: list[Question | Switch]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		from .questionnaire import QuestionnaireWidget

		__all__ = ["QuestionnaireWidget"]