Skip to main content

Publish data sets, models, and other python objects, making it easy to share them across projects and with your colleagues.

Project description

pins

PyPI - Version PyPI - Python Version Checked with pyright

The pins package publishes data, models, and other Python objects, making it easy to share them across projects and with your colleagues. You can pin objects to a variety of pin boards, including folders (to share on a networked drive or with services like DropBox), Posit Connect, Amazon S3, and Google Cloud Storage. Pins can be automatically versioned, making it straightforward to track changes, re-run analyses on historical data, and undo mistakes.

See the documentation for getting started.

You can use pins from R as well as Python. For example, you can use one language to read a pin created with the other. Learn more about pins for R.

Installation

You can install the released version of pins from PyPI:

python -m pip install pins

And the development version from GitHub with:

python -m pip install git+https://github.com/rstudio/pins-python

Usage

To use the pins package, you must first create a pin board. A good place to start is board_folder(), which stores pins in a directory you specify. Here I’ll use a special version of board_folder() called board_temp() which creates a temporary board that’s automatically deleted when your Python script or notebook session ends. This is great for examples, but obviously you shouldn’t use it for real work!

import pins
from pins.data import mtcars

board = pins.board_temp()

You can “pin” (save) data to a board with the .pin_write() method. It requires three arguments: an object, a name, and a pin type:

board.pin_write(mtcars.head(), "mtcars", type="csv")
Writing pin:
Name: 'mtcars'
Version: 20230523T115348Z-120a5

Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20230523T115348Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2023, 5, 23, 11, 53, 48, 555797), hash='120a54f7e0818041'), tags=None, name='mtcars', user={}, local={})

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

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

board.pin_read("mtcars")
    mpg  cyl   disp   hp  drat     wt   qsec  vs  am  gear  carb
0  21.0    6  160.0  110  3.90  2.620  16.46   0   1     4     4
1  21.0    6  160.0  110  3.90  2.875  17.02   0   1     4     4
2  22.8    4  108.0   93  3.85  2.320  18.61   1   1     4     1
3  21.4    6  258.0  110  3.08  3.215  19.44   1   0     3     1
4  18.7    8  360.0  175  3.15  3.440  17.02   0   0     3     2

A board on your computer is good place to start, but the real power of pins comes when you use a board that’s shared with multiple people. To get started, you can use board_folder() with a directory on a shared drive or in DropBox, or if you use Posit Connect you can use board_connect():

# Note that this uses one approach to connecting,
# the environment variables CONNECT_SERVER and CONNECT_API_KEY

board = pins.board_connect()
board.pin_write(tidy_sales_data, "hadley/sales-summary", type="csv")

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

board = board_connect()
board.pin_read("hadley/sales-summary")

You can easily control who gets to access the data using the Posit Connect permissions pane.

The pins package also includes boards that allow you to share data on services like Amazon’s S3 (board_s3()), Google Cloud Storage (board_gcs()), and Azure blob storage (board_azure()).

Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pins-0.9.0.tar.gz (119.8 kB view details)

Uploaded Source

Built Distribution

pins-0.9.0-py2.py3-none-any.whl (122.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pins-0.9.0.tar.gz.

File metadata

  • Download URL: pins-0.9.0.tar.gz
  • Upload date:
  • Size: 119.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pins-0.9.0.tar.gz
Algorithm Hash digest
SHA256 6d209dfc97a1a19d0ed7f364341d1ae76739a2776cb127a18b307c64a1c4b4a9
MD5 7fae539eee8aa1d350c40d5b2c99705b
BLAKE2b-256 e23851960b17555d5b4199b0223198b5193e00a72e95b6c0d7975e78073342b2

See more details on using hashes here.

File details

Details for the file pins-0.9.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pins-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 122.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pins-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f34fbf057e8605119b866c562174a14fbf5129eab2153d3c268b657f0ee809b4
MD5 5b0c03a254ee719c1489cf2312cf273e
BLAKE2b-256 eed9dce08b937984df99a810a529975dc77369063fedc93a38fd0f45ff979bb0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page