Skip to content

Commit fed271a

Browse files
authored
maint: move from deploy_rsconnect to deploy_connect (#226)
* add deploy_connect * use deploy_connect in tests
1 parent a466e36 commit fed271a

File tree

3 files changed

+44
-5
lines changed

3 files changed

+44
-5
lines changed

vetiver/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
"""vetiver - Python parallel to R vetiver package"""
2+
23
# Change to import.metadata when minimum python>=3.8
34
from importlib_metadata import version as _version
45

@@ -22,7 +23,7 @@
2223
from .handlers.xgboost import XGBoostHandler # noqa
2324
from .handlers.spacy import SpacyHandler # noqa
2425
from .helpers import api_data_to_frame # noqa
25-
from .rsconnect import deploy_rsconnect # noqa
26+
from .rsconnect import deploy_connect, deploy_rsconnect # noqa
2627
from .monitor import compute_metrics, pin_metrics, plot_metrics, _rolling_df # noqa
2728
from .templates import model_card, monitoring_dashboard # noqa
2829
from .types import create_prototype, Prototype # noqa

vetiver/rsconnect.py

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
import shutil
33
import tempfile
44
import typing
5+
import warnings
56

67
from rsconnect.actions import deploy_python_fastapi
78
from rsconnect.api import RSConnectServer as ConnectServer
89

910
from .write_fastapi import write_app
1011

1112

12-
def deploy_rsconnect(
13+
def deploy_connect(
1314
connect_server: ConnectServer,
1415
board,
1516
pin_name: str,
@@ -68,7 +69,7 @@ def deploy_rsconnect(
6869
)
6970
7071
# Deploy model, which should already be pinned on Posit Connect
71-
vetiver.deploy_rsconnect(
72+
vetiver.deploy_connect(
7273
connect_server = connect_server,
7374
board = board,
7475
pin_name = "my_model"
@@ -116,3 +117,40 @@ def deploy_rsconnect(
116117
log_callback=log_callback,
117118
image=image,
118119
)
120+
121+
122+
def deploy_rsconnect(
123+
connect_server: ConnectServer,
124+
board,
125+
pin_name: str,
126+
version: str = None,
127+
extra_files: typing.List[str] = None,
128+
new: bool = False,
129+
app_id: int = None,
130+
title: str = None,
131+
python: str = None,
132+
force_generate: bool = False,
133+
log_callback: typing.Callable = None,
134+
image: str = None,
135+
):
136+
"""Deprecated. Use `deploy_connect` instead."""
137+
138+
warnings.warn(
139+
"deploy_rsconnect is deprecated and will be removed in a future version. "
140+
"Use deploy_connect instead."
141+
)
142+
143+
deploy_connect(
144+
connect_server=connect_server,
145+
board=board,
146+
pin_name=pin_name,
147+
version=version,
148+
extra_files=extra_files,
149+
new=new,
150+
app_id=app_id,
151+
title=title,
152+
python=python,
153+
force_generate=force_generate,
154+
log_callback=log_callback,
155+
image=image,
156+
)

vetiver/tests/test_rsconnect.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ def test_deploy(rsc_short):
6868

6969
v = vetiver.VetiverModel(model=model, prototype_data=X_df, model_name="susan/model")
7070

71-
board = pins.board_rsconnect(
71+
board = pins.board_connect(
7272
server_url=RSC_SERVER_URL, api_key=get_key("susan"), allow_pickle_read=True
7373
)
7474

7575
vetiver.vetiver_pin_write(board=board, model=v)
7676
connect_server = RSConnectServer(url=RSC_SERVER_URL, api_key=get_key("susan"))
7777
assert isinstance(board.pin_read("susan/model"), sklearn.dummy.DummyRegressor)
7878

79-
vetiver.deploy_rsconnect(
79+
vetiver.deploy_connect(
8080
connect_server=connect_server,
8181
board=board,
8282
pin_name="susan/model",

0 commit comments

Comments
 (0)