Skip to content

Commit 60205ec

Browse files
committed
docs: regenerate README
1 parent 4d596da commit 60205ec

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/machow/pins-python/HEAD)
44

5-
The pins package publishes data, models, and other python objects, making it
5+
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
88
networked drive or with services like DropBox), RStudio Connect, and Amazon
@@ -43,11 +43,15 @@ arguments: an object, a name, and a pin type:
4343
board.pin_write(mtcars.head(), "mtcars", type="csv")
4444
```
4545

46-
```
47-
## Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20220524T122819Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2022, 5, 24, 12, 28, 19, 765459), hash='120a54f7e0818041'), name='mtcars', user={})
48-
##
49-
## Writing to pin 'mtcars'
50-
```
46+
Writing to pin 'mtcars'
47+
48+
49+
50+
51+
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={})
53+
54+
5155

5256
Above, we saved the data as a CSV, but depending on
5357
what you’re saving and who else you want to read it, you might use the
@@ -60,14 +64,17 @@ You can later retrieve the pinned data with `.pin_read()`:
6064
board.pin_read("mtcars")
6165
```
6266

63-
```
64-
## mpg cyl disp hp drat wt qsec vs am gear carb
65-
## 0 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
66-
## 1 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
67-
## 2 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
68-
## 3 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
69-
## 4 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
70-
```
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+
7178

7279
A board on your computer is good place to start, but the real power of
7380
pins comes when you use a board that’s shared with multiple people. To

0 commit comments

Comments
 (0)