Skip to content

Commit ec44e98

Browse files
committed
docs: regenerate README
1 parent 9b41604 commit ec44e98

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ specify. Here I’ll use a special version of `board_folder()` called
2727
deleted when your R session ends. This is great for examples, but
2828
obviously you shouldn't use it for real work!
2929

30+
3031
```python
3132
import pins
3233
from pins.data import mtcars
@@ -37,20 +38,44 @@ board = pins.board_temp()
3738
You can “pin” (save) data to a board with the `.pin_write()` method. It requires three
3839
arguments: an object, a name, and a pin type:
3940

41+
4042
```python
4143
board.pin_write(mtcars.head(), "mtcars", type="csv")
4244
```
4345

46+
Writing to pin 'mtcars'
47+
48+
49+
50+
51+
52+
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20220513T174015Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2022, 5, 13, 17, 40, 15, 184665), hash='120a54f7e0818041'), name='mtcars', user={})
53+
54+
55+
4456
Above, we saved the data as a CSV, but depending on
4557
what you’re saving and who else you want to read it, you might use the
4658
`type` argument to instead save it as a `joblib` or `arrow` file (NOTE: arrow is not yet supported).
4759

4860
You can later retrieve the pinned data with `.pin_read()`:
4961

62+
5063
```python
5164
board.pin_read("mtcars")
5265
```
5366

67+
68+
69+
70+
mpg cyl disp hp drat wt qsec vs am gear carb
71+
0 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
72+
1 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
73+
2 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
74+
3 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
75+
4 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
76+
77+
78+
5479
A board on your computer is good place to start, but the real power of
5580
pins comes when you use a board that’s shared with multiple people. To
5681
get started, you can use `board_folder()` with a directory on a shared

0 commit comments

Comments
 (0)