revisit 0.0.23__tar.gz → 0.0.25__tar.gz

revisit-0.0.25/.gitignore

@@ -0,0 +1,16 @@
+node_modules
+.venv
+dist
+.DS_Store
+
+# Python
+__pycache__
+.ipynb_checkpoints
+
+src/revisit/static
+
+# Ignoring all scripts except for single test_script
+scripts/*
+!scripts/test_script.py
+!scripts/test_script.ipynb
+!scripts/

{revisit-0.0.23/src/revisit.egg-info → revisit-0.0.25}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: revisit
-Version: 0.0.23
-Description-Content-Type: text/markdown
+Version: 0.0.25
 Requires-Dist: anywidget
-Requires-Dist: pydantic>=2.10.5
 Requires-Dist: pandas
+Requires-Dist: pydantic>=2.10.5
 Provides-Extra: dev
-Requires-Dist: watchfiles; extra == "dev"
-Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: jupyterlab; extra == 'dev'
+Requires-Dist: watchfiles; extra == 'dev'
+Description-Content-Type: text/markdown
 
 # revisit
 
@@ -236,7 +236,201 @@ print(component_two)
 '''
 ```
 
+#### `clone(component_name__) -> Component`
+
+**Description**:
+Clones the component with the given new component name.
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`    | `str`   | New component name to assign to cloned component.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+test_response = rvt.response(
+    id='test_response',
+    type='shortText',
+    prompt='Original Prompt:',
+    required=True
+)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=[test_response]
+)
+
+component_two = component_one.clone(component_name__='component_two').edit_response(id='test_response', prompt='New Prompt', required=False)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "Original Prompt:",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+print(component_two)
+'''
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "New Prompt",
+            "required": false,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
+
+#### `Response`
+
+**Description**:  
+A brief summary of the class's purpose and functionality.
+
+#### **Attributes**:
+| Attribute   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`     | `type`   | Description of attribute 1.         | `default`     |
+| `base__`     | `type`   | Description of attribute 2.         | _None_        |
+
+
+#### **Methods**:
+
+#### `set(**kwargs: dict) -> self`
+
+**Description**:
+
+Sets the values of the response to the input dictionary. The `type` cannot be changed and would require creating a new response
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `**kwargs`    | `dict`   | Dictionary containing valid values for the current response type.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Raises**:
+- `RevisitError`: If the user attempts to change the `type` attribute of the response, an exception will be raised. Any invalid inputs for the instantiated response type will also raise an exception.
+
+#### **Examples**:
+```python
+response_one = rvt.response(
+    id='r-1',
+    type='shortText',
+    required=False,
+    location='belowStimulus',
+    prompt=''
+)
+
+response_one.set(prompt='New Prompt')
+print(response_one)
+'''
+Expected Output
+{
+    "id": "r-1",
+    "location": "belowStimulus",
+    "prompt": "New Prompt",
+    "required": false,
+    "type": "shortText"
+}
+'''
+
+response_one.set(type='longText')
+# Raises Exception: 'Cannot change type from shortText to longText'
+
+response_one.set(options=[1,2,3])
+
+```
+
+#### `clone() -> Response`
+
+**Description**:
+Clones the response.
+
+**Parameters**:  
+_No parameters_
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+import random
+question_1 = rvt.response(
+    id='q-1',
+    type='shortText',
+    prompt='What is 4 - 2?',
+    required=True,
+    location='belowStimulus'
+)
+
+# Initialize a list with first question
+final_responses = [question_1]
+
+# Randomly generate different arithmetic questions by cloning original question.
+for i in range(2, 21):
+    curr_response = question_1.clone().set(
+        id=f'q-{i}',
+        prompt=f'What is {random.randint(1, 10)} - {random.randint(1, 10)}'
+    )
+    final_responses.append(curr_response)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=final_responses
+)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "q-1",
+            "location": "belowStimulus",
+            "prompt": "What is 4 - 2?",
+            "required": true,
+            "type": "shortText"
+        },
+        {
+            "id": "q-2",
+            "location": "belowStimulus",
+            "prompt": "What is 10 - 4",
+            "required": true,
+            "type": "shortText"
+        },
+
+        ...
 
+        {
+            "id": "q-20",
+            "location": "belowStimulus",
+            "prompt": "What is 2 - 5",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
 
 ## Development
 
@@ -286,4 +480,4 @@ datamodel-codegen --input src/revisit/StudyConfigSchema.json --output src/revisi
 ```bash
 cd revisit-py
 python -m unittest tests.test_module_one
-```
+```

revisit-0.0.23/PKG-INFO → revisit-0.0.25/README.md

@@ -1,14 +1,3 @@
-Metadata-Version: 2.2
-Name: revisit
-Version: 0.0.23
-Description-Content-Type: text/markdown
-Requires-Dist: anywidget
-Requires-Dist: pydantic>=2.10.5
-Requires-Dist: pandas
-Provides-Extra: dev
-Requires-Dist: watchfiles; extra == "dev"
-Requires-Dist: jupyterlab; extra == "dev"
-
 # revisit
 
 ## Installation
@@ -236,7 +225,201 @@ print(component_two)
 '''
 ```
 
+#### `clone(component_name__) -> Component`
+
+**Description**:
+Clones the component with the given new component name.
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`    | `str`   | New component name to assign to cloned component.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+test_response = rvt.response(
+    id='test_response',
+    type='shortText',
+    prompt='Original Prompt:',
+    required=True
+)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=[test_response]
+)
 
+component_two = component_one.clone(component_name__='component_two').edit_response(id='test_response', prompt='New Prompt', required=False)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "Original Prompt:",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+print(component_two)
+'''
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "New Prompt",
+            "required": false,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
+
+#### `Response`
+
+**Description**:  
+A brief summary of the class's purpose and functionality.
+
+#### **Attributes**:
+| Attribute   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`     | `type`   | Description of attribute 1.         | `default`     |
+| `base__`     | `type`   | Description of attribute 2.         | _None_        |
+
+
+#### **Methods**:
+
+#### `set(**kwargs: dict) -> self`
+
+**Description**:
+
+Sets the values of the response to the input dictionary. The `type` cannot be changed and would require creating a new response
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `**kwargs`    | `dict`   | Dictionary containing valid values for the current response type.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Raises**:
+- `RevisitError`: If the user attempts to change the `type` attribute of the response, an exception will be raised. Any invalid inputs for the instantiated response type will also raise an exception.
+
+#### **Examples**:
+```python
+response_one = rvt.response(
+    id='r-1',
+    type='shortText',
+    required=False,
+    location='belowStimulus',
+    prompt=''
+)
+
+response_one.set(prompt='New Prompt')
+print(response_one)
+'''
+Expected Output
+{
+    "id": "r-1",
+    "location": "belowStimulus",
+    "prompt": "New Prompt",
+    "required": false,
+    "type": "shortText"
+}
+'''
+
+response_one.set(type='longText')
+# Raises Exception: 'Cannot change type from shortText to longText'
+
+response_one.set(options=[1,2,3])
+
+```
+
+#### `clone() -> Response`
+
+**Description**:
+Clones the response.
+
+**Parameters**:  
+_No parameters_
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+import random
+question_1 = rvt.response(
+    id='q-1',
+    type='shortText',
+    prompt='What is 4 - 2?',
+    required=True,
+    location='belowStimulus'
+)
+
+# Initialize a list with first question
+final_responses = [question_1]
+
+# Randomly generate different arithmetic questions by cloning original question.
+for i in range(2, 21):
+    curr_response = question_1.clone().set(
+        id=f'q-{i}',
+        prompt=f'What is {random.randint(1, 10)} - {random.randint(1, 10)}'
+    )
+    final_responses.append(curr_response)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=final_responses
+)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "q-1",
+            "location": "belowStimulus",
+            "prompt": "What is 4 - 2?",
+            "required": true,
+            "type": "shortText"
+        },
+        {
+            "id": "q-2",
+            "location": "belowStimulus",
+            "prompt": "What is 10 - 4",
+            "required": true,
+            "type": "shortText"
+        },
+
+        ...
+
+        {
+            "id": "q-20",
+            "location": "belowStimulus",
+            "prompt": "What is 2 - 5",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
 
 ## Development
 
@@ -286,4 +469,4 @@ datamodel-codegen --input src/revisit/StudyConfigSchema.json --output src/revisi
 ```bash
 cd revisit-py
 python -m unittest tests.test_module_one
-```
+```

{revisit-0.0.23 → revisit-0.0.25}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools", "wheel"]  # Use setuptools for builds
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [project]
 name = "revisit"
-version = "0.0.23"
+version = "0.0.25"
 dependencies = [
     "anywidget",
     "pydantic>=2.10.5",