docstring

Author: isabelizimm

vetiver/__init__.py

@@ -7,7 +7,7 @@
 import importlib
 from .ptype import *
 from .vetiver_model import VetiverModel
-from .server import VetiverAPI, vetiver_endpoint
+from .server import VetiverAPI, vetiver_endpoint, predict
 from .mock import get_mock_data, get_mock_model
 from .pin_read_write import vetiver_pin_write
 from .attach_pkgs import *

vetiver/rsconnect.py

@@ -1,15 +1,17 @@
 import tempfile
 import typing
 from rsconnect.actions import deploy_python_fastapi
+import shutil
+import os
 
 from .write_fastapi import write_app
 
 
 def deploy_rsconnect(
     connect_server,
     board,
-    pin_name,
-    version = None,
+    pin_name: str,
+    version: str = None,
     extra_files: typing.List[str] = None,
     new: bool = False,
     app_id: int = None,
@@ -20,11 +22,54 @@ def deploy_rsconnect(
     log_callback: typing.Callable = None,
     image: str = None,
 ):
+    """Deploy to RSConnect
+
+    Parameters
+    ----------
+        connect_server: 
+            RSConnect Server
+        board: 
+            Pins board
+        pin_name: str
+            Name of pin
+        version: str
+            Version of pin
+        extra_files: typing.List[str]
+            Any extra files to include in 
+        new:
+            Force as a new deploy
+        app_id:
+            ID of an existing application to deploy new files for.
+        title: str
+            Optional title for the deploy.
+        python: str
+            Optional name of a Python executable
+        conda_mode: bool
+            Use conda to build an environment.yml
+        force_generate: bool    
+            Force generating "requirements.txt" or "environment.yml"
+        log_callback: typing.Callable
+            Callback to use to write the log to
+        image: str
+            Docker image to be specified for off-host execution
+    """
+    if board.fs.protocol == "rsc":
+        raise NotImplementedError()
+
     if not title:
         title = pin_name + "_vetiver"
 
     with tempfile.TemporaryDirectory() as temp:
+        if extra_files is not None:
+            new_files = []
+            for file in extra_files:
+                filename = os.path.basename(file)
+                shutil.copyfile(file, os.path.join(temp, filename))
+                new_files = new_files + [os.path.join(temp, filename)]
+            extra_files = new_files
+                
         tmp_app = temp + "/app.py"
+
         write_app(
             board=board,
             pin_name=pin_name,

vetiver/tests/test_rsconnect.py

@@ -1,7 +1,5 @@
 import pytest
 import json
-import requests
-
 import sklearn
 from pins.boards import BoardRsConnect
 
@@ -70,8 +68,9 @@ def test_board_pin_write(rsc_short):
     vetiver.vetiver_pin_write(board=rsc_short, model=v)
     assert isinstance(rsc_short.pin_read("susan/model"), sklearn.dummy.DummyRegressor)
 
-
+@pytest.mark.xfail
 def test_deploy(rsc_short):
+    # TODO: test in Dockerfile
     v = vetiver.VetiverModel(
         model=model, ptype_data=X_df, model_name="susan/model", versioned=None
     )
@@ -83,6 +82,6 @@ def test_deploy(rsc_short):
         board=rsc_short, 
         pin_name="susan/model"
     )
-    response = requests.post(RSC_SERVER_URL + "/predict/", json=X_df)
+    response = vetiver.predict(RSC_SERVER_URL + "/predict/", json=X_df)
     assert response.status_code == 200, response.text
     assert response.json() == {"prediction": [44.47, 44.47]}, response.json()