Skip to content

Commit e391ad6

Browse files
committed
docs: regenerate readme
1 parent 956aca8 commit e391ad6

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
The pins package publishes data, models, and other Python objects, making it
66
easy to share them across projects and with your colleagues. You can pin
77
objects to a variety of pin *boards*, including folders (to share on a
8-
networked drive or with services like DropBox), RStudio Connect, Amazon S3,
9-
and Google Cloud Storage.
8+
networked drive or with services like DropBox), Posit Connect, and Amazon
9+
S3, and Google Cloud Storage.
1010
Pins can be automatically versioned, making it straightforward to track changes,
1111
re-run analyses on historical data, and undo mistakes.
1212

13+
See the [documentation](https://rstudio.github.io/pins-python) for getting started.
14+
1315
## Installation
1416

1517
```shell
@@ -43,19 +45,21 @@ arguments: an object, a name, and a pin type:
4345
board.pin_write(mtcars.head(), "mtcars", type="csv")
4446
```
4547

46-
Writing to pin 'mtcars'
48+
Writing pin:
49+
Name: 'mtcars'
50+
Version: 20230316T105526Z-120a5
4751

4852

4953

5054

5155

52-
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20220526T165625Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2022, 5, 26, 16, 56, 25, 738735), hash='120a54f7e0818041'), name='mtcars', user={})
56+
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20230316T105526Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2023, 3, 16, 10, 55, 26, 770168), hash='120a54f7e0818041'), tags=None, name='mtcars', user={}, local={})
5357

5458

5559

5660
Above, we saved the data as a CSV, but depending on
5761
what you’re saving and who else you want to read it, you might use the
58-
`type` argument to instead save it as a `joblib` or `arrow` file.
62+
`type` argument to instead save it as a `joblib`, `parquet`, or `json` file.
5963

6064
You can later retrieve the pinned data with `.pin_read()`:
6165

@@ -79,7 +83,7 @@ board.pin_read("mtcars")
7983
A board on your computer is good place to start, but the real power of
8084
pins comes when you use a board that’s shared with multiple people. To
8185
get started, you can use `board_folder()` with a directory on a shared
82-
drive or in DropBox, or if you use [RStudio
86+
drive or in DropBox, or if you use [Posit
8387
Connect](https://www.rstudio.com/products/connect/) you can use
8488
`board_rsconnect()`:
8589

@@ -99,12 +103,12 @@ board = board_rsconnect()
99103
board.pin_read("hadley/sales-summary")
100104
```
101105

102-
You can easily control who gets to access the data using the RStudio
106+
You can easily control who gets to access the data using the Posit
103107
Connect permissions pane.
104108

105109
The pins package also includes boards that allow you to share data on
106-
services like Amazon’s S3 (`board_s3()`), and Google Cloud Storage (`board_gcs`), with plans to support other backends--
107-
such as Azure's blob storage.
110+
services like Amazon’s S3 (`board_s3()`), Google Cloud Storage (`board_gcs()`),
111+
and Azure blob storage (`board_azure()`).
108112

109113
## Development
110114

0 commit comments

Comments
 (0)