Skip to content

Commit 33e824b

Browse files
authored
Merge pull request #195 from rstudio/docs-readme
docs: update README
2 parents 6086cd9 + d3ab07d commit 33e824b

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

README.Rmd

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ pd.set_option("display.notebook_repr_html", False)
77

88
# pins-python
99

10-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/machow/pins-python/HEAD)
11-
1210
The pins package publishes data, models, and other Python objects, making it
1311
easy to share them across projects and with your colleagues. You can pin
1412
objects to a variety of pin *boards*, including folders (to share on a
@@ -64,22 +62,22 @@ A board on your computer is good place to start, but the real power of
6462
pins comes when you use a board that’s shared with multiple people. To
6563
get started, you can use `board_folder()` with a directory on a shared
6664
drive or in DropBox, or if you use [Posit
67-
Connect](https://www.rstudio.com/products/connect/) you can use
68-
`board_rsconnect()`:
65+
Connect](https://posit.co/products/enterprise/connect/) you can use
66+
`board_connect()`:
6967

7068
```python
7169
# Note that this uses one approach to connecting,
7270
# the environment variables CONNECT_SERVER and CONNECT_API_KEY
7371

74-
board = pins.board_rsconnect()
72+
board = pins.board_connect()
7573
board.pin_write(tidy_sales_data, "hadley/sales-summary", type="csv")
7674
```
7775

7876
Then, someone else (or an automated report) can read and use your
7977
pin:
8078

8179
```python
82-
board = board_rsconnect()
80+
board = board_connect()
8381
board.pin_read("hadley/sales-summary")
8482
```
8583

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# pins-python
22

3-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/machow/pins-python/HEAD)
4-
53
The pins package publishes data, models, and other Python objects, making it
64
easy to share them across projects and with your colleagues. You can pin
75
objects to a variety of pin *boards*, including folders (to share on a
@@ -47,13 +45,13 @@ board.pin_write(mtcars.head(), "mtcars", type="csv")
4745

4846
Writing pin:
4947
Name: 'mtcars'
50-
Version: 20230321T151326Z-120a5
48+
Version: 20230410T151442Z-120a5
5149

5250

5351

5452

5553

56-
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20230321T151326Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2023, 3, 21, 15, 13, 26, 362951), hash='120a54f7e0818041'), tags=None, name='mtcars', user={}, local={})
54+
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20230410T151442Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2023, 4, 10, 15, 14, 42, 55001), hash='120a54f7e0818041'), tags=None, name='mtcars', user={}, local={})
5755

5856

5957

@@ -84,22 +82,22 @@ A board on your computer is good place to start, but the real power of
8482
pins comes when you use a board that’s shared with multiple people. To
8583
get started, you can use `board_folder()` with a directory on a shared
8684
drive or in DropBox, or if you use [Posit
87-
Connect](https://www.rstudio.com/products/connect/) you can use
88-
`board_rsconnect()`:
85+
Connect](https://posit.co/products/enterprise/connect/) you can use
86+
`board_connect()`:
8987

9088
```python
9189
# Note that this uses one approach to connecting,
9290
# the environment variables CONNECT_SERVER and CONNECT_API_KEY
9391

94-
board = pins.board_rsconnect()
92+
board = pins.board_connect()
9593
board.pin_write(tidy_sales_data, "hadley/sales-summary", type="csv")
9694
```
9795

9896
Then, someone else (or an automated report) can read and use your
9997
pin:
10098

10199
```python
102-
board = board_rsconnect()
100+
board = board_connect()
103101
board.pin_read("hadley/sales-summary")
104102
```
105103

0 commit comments

Comments
 (0)