Skip to main content

pin_upload

boards.BaseBoard.pin_upload(
    paths,
    name=None,
    title=None,
    description=None,
    metadata=None,
    *,
    data_dict=None,
    force_identical_write=False,
)

Write a pin based on paths to one or more files.

This method simply uploads the files given, so they can be downloaded later using pin_download.

Parameters

Name Type Description Default
paths str | list[str] Paths of files to upload. Currently, only uploading a single file is supported. required
name Pin name. None
title A title for the pin; most important for shared boards so that others can understand what the pin contains. If omitted, a brief description of the contents will be automatically generated. None
description A detailed description of the pin contents. None
metadata A dictionary containing additional metadata to store with the pin. This gets stored on the Meta.user field. None
data_dict bool | str | Path | None Optional YAML file path, or True to draft from Parquet files. For Connect, the publisher renders dictionary.html; index.html keeps the pin overview and adds the dictionary view. None
force_identical_write bool Store a new version even when only the metadata changes. False