revisit 0.0.27__py2.py3-none-any.whl → 0.0.28__py2.py3-none-any.whl

revisit/revisit.py

@@ -45,7 +45,6 @@ class _WrappedResponse(_JSONableBaseModel):
         self.root = self.root.root
 
     def set(self, overwrite=True, **kwargs) -> _WrappedResponse:
-        print('but I got here')
         for key, value in kwargs.items():
             # Disallow changing type
             if key == 'type':
@@ -54,7 +53,6 @@ class _WrappedResponse(_JSONableBaseModel):
             elif key != 'base':
                 if overwrite is True or (overwrite is False and getattr(self.root, key) is None):
                     setattr(self.root, key, value)
-        print('do I get here???')
         # Re-validates the model. Returns the new model.
         self.root = _validate_response(self.root.__dict__)
         return self
@@ -454,9 +452,39 @@ def data(file_path: str) -> List[Any]:
     return data_rows
 
 
-def widget(study: _WrappedStudyConfig, revisitPath: str):
-    if not os.path.isdir(revisitPath):
-        raise RevisitError(message=f'"{revisitPath}" does not exist.')
+def widget(study: _WrappedStudyConfig, revisitPath: str = '', server=False, pathToLib=''):
+
+    # If server is set to true, needs to use the correct package path.
+    # If server is not true, needs to have a valid revisitPath. I think we already handle that below
+
+    if server is False and not os.path.isdir(revisitPath):
+        raise RevisitError(message=f'"{revisitPath}" does not exist. Specify a correct revisitPath or use the revisti_server module and set "server" to "True".')
+
+    # Set defaults for when not using server.
+    dest_loc = f"{revisitPath}/public/__revisit-widget/assets/"
+    dest_loc_react = f"{revisitPath}/src/public/__revisit-widget/assets/"
+    
+    # If using server,
+    if server is True:
+        # If not path specified, search in current environment.
+        if pathToLib == '':
+            # Get working directory
+            current_dir = os.getcwd()
+            # Get parent directory (list of packages installed in .venv)
+            parent_dir = os.path.dirname(current_dir)
+
+            # Construct the path to the revisit_server package
+            revisit_server_dir = os.path.join(parent_dir, 'revisit_server')
+            if not os.path.isdir(revisit_server_dir):
+                raise RevisitError(message='Cannot locate "revisit_server" package in current environment. Specify directory using "pathToLib" or install "revisit_server" in same environment as "revisit" package.')
+
+            dest_loc = f"{revisit_server_dir}/static/__revisit-widget/assets/"
+        else:
+            if not os.path.isdir(pathToLib):
+                raise RevisitError(message=f'"{pathToLib}" is not a directory.')
+            dest_loc = f"{pathToLib}/static/__revisit-widget/assets/"
+            if not os.path.isdir(dest_loc):
+                raise RevisitError(message=f'"{dest_loc}" is not a directory.')
 
     extracted_paths = []
 
@@ -469,11 +497,12 @@ def widget(study: _WrappedStudyConfig, revisitPath: str):
             fileName = actual_component.path.split('/')[-1]
 
             if actual_component.type == 'react-component':
-                dest = f"{revisitPath}/src/public/__revisit-widget/assets/{fileName}"
+                dest = f"{dest_loc_react}{fileName}"
             else:
-                dest = f"{revisitPath}/public/__revisit-widget/assets/{fileName}"
+                dest = f"{dest_loc}{fileName}"
 
             extracted_paths.append({
+                "type": actual_component.type,
                 "src": actual_component.path,
                 "dest": dest
             })
@@ -485,9 +514,10 @@ def widget(study: _WrappedStudyConfig, revisitPath: str):
     if uiConfig.helpTextPath is not None:
 
         fileName = uiConfig.helpTextPath.split('/')[-1]
-        dest = f"{revisitPath}/public/__revisit-widget/assets/{fileName}"
+        dest = f"{dest_loc}{fileName}"
 
         extracted_paths.append({
+            "type": 'helpTextPath',
             "src": uiConfig.helpTextPath,
             "dest": dest
         })
@@ -499,9 +529,10 @@ def widget(study: _WrappedStudyConfig, revisitPath: str):
 
         fileName = uiConfig.logoPath.split('/')[-1]
 
-        dest = f"{revisitPath}/public/__revisit-widget/assets/{fileName}"
+        dest = f"{dest_loc}{fileName}"
 
         extracted_paths.append({
+            "type": 'logoPath',
             "src": uiConfig.logoPath,
             "dest": dest
         })
@@ -511,7 +542,10 @@ def widget(study: _WrappedStudyConfig, revisitPath: str):
 
     # Copy all files
     for item in extracted_paths:
-        _copy_file(item['src'], item['dest'])
+        if item['type'] == 'react-component' and server is True:
+            print('Skipping react component when "server" is set to "True".')
+        else:
+            _copy_file(item['src'], item['dest'])
 
     w = _widget.Widget()
     w.config = json.loads(study.__str__())

{revisit-0.0.27.dist-info → revisit-0.0.28.dist-info}/METADATA

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: revisit
-Version: 0.0.27
+Version: 0.0.28
 Requires-Dist: anywidget
 Requires-Dist: pandas
 Requires-Dist: pydantic>=2.10.5
+Requires-Dist: revisit-server>=0.0.1
 Provides-Extra: dev
 Requires-Dist: jupyterlab; extra == 'dev'
 Requires-Dist: watchfiles; extra == 'dev'
@@ -101,11 +102,40 @@ my_response = rvt.response(
 )
 ```
 
+## `studyMetadata(**kwargs: dict) -> StudyMetadata`
+
+## `uiConfig(**kwargs: dict) -> UIConfig`
+
+### `studyConfig(studyMetadata: StudyMetadata, uiConfig: UIConfig, sequence: ComponentBlock, schema: str, components: Optional[List[Component]]) -> StudyConfig`
+
+Instantiates a the final `StudyConfig` based on the `UIConfig`, `StudyMetadata`, `Sequence`, and `Components` input. Note that the components list is completely optional: using the `studyConfig` factory function automatically populates all components based on their presence in the sequence.
+
+### **Parameters**:
+| Parameter | Type   | Description                     | Default Value |
+|-----------|--------|---------------------------------|---------------|
+| `studyMetadata` | `StudyMetadata` | An instance of the `StudyMetadata` class | _None_ |
+| `uiConfig` | `UIConfig` | An instance of the `UIConfig` class | _None_ |
+| `sequence` | `ComponentBlock` | The top level member of your sequence. | _None_ |
+| `components` | `Optional[List[Component]]` | The list of `Component`s to be added to the config. This is automatically populated based on the inputted sequence | `[]` |
+| `schema` | `str` |The valid `$schema` value for the config | _None_ |
+
+### **Returns**:
+- `StudyConfig`: Returns an instantiation of the StudyConfig class.
+
+### **Raises**:
+- `RevisitError`: If the required properties are not specified, and exception will be raised.
+
+### **Example**:
+
+```python
+
+```
+
 # Classes 
 
 ## `Component`
 
-A brief summary of the class's purpose and functionality.
+The class that is instantiated when calling the `component` factory function. Used to define the components in the study configuration file.
 
 ### **Attributes**:
 | Attribute   | Type     | Description                         | Default Value |

{revisit-0.0.27.dist-info → revisit-0.0.28.dist-info}/RECORD

@@ -1,10 +1,10 @@
 revisit/StudyConfigSchema.json,sha256=xtzwZifuPJoiHASx0o8PHqBuh5L30mjBlhQ5eqsYm10,132168
 revisit/__init__.py,sha256=QCvYt8m9QwpjcK4dv6GlLMUDCzRXGy16cua1r2biNCg,255
 revisit/models.py,sha256=FRy8IlUAtDS3gdmZwwvqR935lbViTPnnr7k0CAkDkzI,134084
-revisit/revisit.py,sha256=DMbT_B-vFf55V6kDKz-Th3FE-qKk3GHk4aq2-Buf2j4,27790
+revisit/revisit.py,sha256=cLCXFrUP0H7IXAsZWFegO6EJBIXuBPl-NKl68-3Fem4,29532
 revisit/widget.py,sha256=VvFqRvvvn86fW8ASe1pxaAvh5ZLvvSRThI5XtlCdgcg,915
 revisit/static/widget.css,sha256=TLu5F6k0CvowQtmApPswG-JZUXYszo7a10dVWKnZsIg,647
 revisit/static/widget.js,sha256=jjc-RvauEnU8dHCR7oGSjg0y1CRXtAlw1-4yDeSbdKE,186472
-revisit-0.0.27.dist-info/METADATA,sha256=0b818mZVHJeCp7P4plpU3J1Hr4KVMsPCoTsvLo4FZfA,22846
-revisit-0.0.27.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-revisit-0.0.27.dist-info/RECORD,,
+revisit-0.0.28.dist-info/METADATA,sha256=dwgAyxwbnoNV6YIq8pfjbRG9VRGM9PLfHSv1OIymKkk,24407
+revisit-0.0.28.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+revisit-0.0.28.dist-info/RECORD,,