rstudio / rstudio/pins-python

Allow users to add s3 tags when they pin_write

Open
#159 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

.enhancement be:s3
Dominant language
Python
Stars
59
Forks
11
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/rstudio/pins-r/issues/628.

Note that pins passes through extra keywords in pin_write to its S3 API library:

board_sales <- board_s3("company-pins", prefix = "sales/")
board_sales %>% pin_write(mtcars, Tagging = "key1=value1&key2=value2")

Here is how s3fs tests tagging:

# from the s3fs tests
def test_tags(s3):
    tagset = {'tag1': 'value1', 'tag2': 'value2'}
    fname = list(files)[0]
    s3.touch(fname)
    s3.put_tags(fname, tagset)
    assert s3.get_tags(fname) == tagset

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Python implementation of pin_write and how it forwards extra keywords to the S3 API library. Review the linked pins-r issue and the s3fs tagging test for the expected tag format and behavior. Done means callers can supply Tagging through pin_write and coverage verifies the tags are applied.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.