Skip to content

Commit 956aca8

Browse files
committed
docs: rename rstudio to posit in some more places
1 parent 94973c5 commit 956aca8

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

README.Rmd

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ pd.set_option("display.notebook_repr_html", False)
1212
The pins package publishes data, models, and other Python objects, making it
1313
easy to share them across projects and with your colleagues. You can pin
1414
objects to a variety of pin *boards*, including folders (to share on a
15-
networked drive or with services like DropBox), RStudio Connect, and Amazon
16-
S3.
15+
networked drive or with services like DropBox), Posit Connect, and Amazon
16+
S3, and Google Cloud Storage.
1717
Pins can be automatically versioned, making it straightforward to track changes,
1818
re-run analyses on historical data, and undo mistakes.
1919

20+
See the [documentation](https://rstudio.github.io/pins-python) for getting started.
21+
2022
## Installation
2123

2224
```shell
@@ -50,7 +52,7 @@ board.pin_write(mtcars.head(), "mtcars", type="csv")
5052

5153
Above, we saved the data as a CSV, but depending on
5254
what you’re saving and who else you want to read it, you might use the
53-
`type` argument to instead save it as a `joblib` or `arrow` file (NOTE: arrow is not yet supported).
55+
`type` argument to instead save it as a `joblib`, `parquet`, or `json` file.
5456

5557
You can later retrieve the pinned data with `.pin_read()`:
5658

@@ -61,7 +63,7 @@ board.pin_read("mtcars")
6163
A board on your computer is good place to start, but the real power of
6264
pins comes when you use a board that’s shared with multiple people. To
6365
get started, you can use `board_folder()` with a directory on a shared
64-
drive or in DropBox, or if you use [RStudio
66+
drive or in DropBox, or if you use [Posit
6567
Connect](https://www.rstudio.com/products/connect/) you can use
6668
`board_rsconnect()`:
6769

@@ -81,12 +83,12 @@ board = board_rsconnect()
8183
board.pin_read("hadley/sales-summary")
8284
```
8385

84-
You can easily control who gets to access the data using the RStudio
86+
You can easily control who gets to access the data using the Posit
8587
Connect permissions pane.
8688

8789
The pins package also includes boards that allow you to share data on
88-
services like Amazon’s S3 (`board_s3()`), with plans to support other backends--
89-
such as Azure's blob storage.
90+
services like Amazon’s S3 (`board_s3()`), Google Cloud Storage (`board_gcs()`),
91+
and Azure blob storage (`board_azure()`).
9092

9193
## Development
9294

pins/constructors.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ def board_deparse(board: BaseBoard):
2929
Examples
3030
--------
3131
32-
The example below deparses a board connected to RStudio Connect.
32+
The example below deparses a board connected to Posit Connect.
3333
3434
>>> board_deparse(board_connect(server_url="http://example.com", api_key="xxx"))
3535
"board_connect(server_url='http://example.com')"
3636
37-
Note that the deparsing an RStudio Connect board does not keep the api_key,
37+
Note that the deparsing a Posit Connect board does not keep the api_key,
3838
which is sensitive information. In this case, you can set the CONNECT_API_KEY
3939
environment variable to connect.
4040
@@ -92,7 +92,7 @@ def board(
9292
Parameters
9393
----------
9494
protocol:
95-
File system protocol. E.g. file, s3, github, rsc (for RStudio Connect).
95+
File system protocol. E.g. file, s3, github, rsc (for Posit Connect).
9696
See fsspec.filesystem for more information.
9797
path:
9898
A base path the board should use. For example, the directory the board lives in,
@@ -356,12 +356,12 @@ def board_url(path: str, pin_paths: dict, cache=DEFAULT, allow_pickle_read=None)
356356
def board_connect(
357357
server_url=None, versioned=True, api_key=None, cache=DEFAULT, allow_pickle_read=None
358358
):
359-
"""Create a board to read and write pins from an RStudio Connect instance.
359+
"""Create a board to read and write pins from an Posit Connect instance.
360360
361361
Parameters
362362
----------
363363
server_url:
364-
Url to the RStudio Connect server.
364+
Url to the Posit Connect server.
365365
api_key:
366366
API key for server. If not specified, pins will attempt to read it from
367367
CONNECT_API_KEY environment variable.

0 commit comments

Comments
 (0)